Skip to content

Commit 0082881

Browse files
committed
Attach attribute docs to the attributes
1 parent f2d47dd commit 0082881

File tree

5 files changed

+448
-1029
lines changed

5 files changed

+448
-1029
lines changed

docs/index.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,14 @@ Web Service Client
99

1010
.. automodule:: minfraud
1111
:members:
12+
:inherited-members:
13+
:show-inheritance:
1214
:no-undoc-members:
1315

1416
.. automodule:: minfraud.webservice
1517
:members:
18+
:inherited-members:
19+
:show-inheritance:
1620
:no-undoc-members:
1721

1822
===============
@@ -21,6 +25,8 @@ Response Models
2125

2226
.. automodule:: minfraud.models
2327
:members:
28+
:inherited-members:
29+
:show-inheritance:
2430
:no-undoc-members:
2531

2632
======
@@ -29,6 +35,8 @@ Errors
2935

3036
.. automodule:: minfraud.errors
3137
:members:
38+
:inherited-members:
39+
:show-inheritance:
3240
:no-undoc-members:
3341

3442
==================

minfraud/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
"""minFraud client module."""
12
# flake8: noqa: F401
23
from .errors import (
34
AuthenticationError,

minfraud/errors.py

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -20,30 +20,16 @@ class HTTPError(MinFraudError):
2020
2121
This class represents an HTTP transport error. It extends
2222
:py:exc:`MinFraudError` and adds attributes of its own.
23-
24-
.. attribute:: http_status:
25-
26-
The HTTP status code returned
27-
28-
:type: int
29-
30-
.. attribute:: uri:
31-
32-
The URI queried
33-
34-
:type: str
35-
36-
.. attribute:: decoded_content:
37-
38-
The decoded response content
39-
40-
:type: str
41-
4223
"""
4324

4425
http_status: Optional[int]
26+
"""The HTTP status code returned"""
27+
4528
uri: Optional[str]
29+
"""The URI queried"""
30+
4631
decoded_content: Optional[str]
32+
"""The decoded response content"""
4733

4834
def __init__(
4935
self,
@@ -52,6 +38,7 @@ def __init__(
5238
uri: Optional[str] = None,
5339
decoded_content: Optional[str] = None,
5440
) -> None:
41+
"""Initialize an HTTPError instance."""
5542
super().__init__(message)
5643
self.http_status = http_status
5744
self.uri = uri

0 commit comments

Comments
 (0)