Skip to content

Commit 40daba8

Browse files
committed
Move headings out of Python to Sphinx template
1 parent 695183b commit 40daba8

File tree

4 files changed

+14
-25
lines changed

4 files changed

+14
-25
lines changed

docs/index.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33

44
.. include:: ../README.rst
55

6-
=======
7-
Modules
8-
=======
6+
==================
7+
Web Service Client
8+
==================
99

1010
.. automodule:: minfraud
1111
:members:
@@ -15,10 +15,18 @@ Modules
1515
:members:
1616
:no-undoc-members:
1717

18+
===============
19+
Response Models
20+
===============
21+
1822
.. automodule:: minfraud.models
1923
:members:
2024
:no-undoc-members:
2125

26+
======
27+
Errors
28+
======
29+
2230
.. automodule:: minfraud.errors
2331
:members:
2432
:no-undoc-members:

minfraud/__init__.py

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
"""
2-
minfraud
3-
~~~~~~~~
4-
5-
A client API to MaxMind's minFraud Score and Insights web services.
6-
"""
7-
81
# flake8: noqa: F401
92
from .errors import (
103
AuthenticationError,

minfraud/models.py

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
1-
"""
2-
minfraud.models
3-
~~~~~~~~~~~~~~~
4-
5-
This module contains models for the minFraud response object.
6-
7-
"""
1+
"""Models for the minFraud response object."""
82

93
# pylint:disable=too-many-lines,too-many-instance-attributes,too-many-locals
104
from collections.abc import Sequence
@@ -22,7 +16,7 @@ def __ne__(self, other: object) -> bool:
2216
return not self.__eq__(other)
2317

2418
def to_dict(self) -> dict:
25-
"""Returns a dict of the object suitable for serialization."""
19+
"""Return a dict of the object suitable for serialization."""
2620
result = {}
2721
for key, value in self.__dict__.items():
2822
if hasattr(value, "to_dict") and callable(value.to_dict):

minfraud/webservice.py

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
1-
"""
2-
minfraud.webservice
3-
~~~~~~~~~~~~~~~~~~~
4-
5-
This module contains the webservice client class.
6-
7-
"""
1+
"""Client for minFraud Score, Insights, and Factors."""
82

93
import json
104
from collections.abc import Sequence

0 commit comments

Comments
 (0)