Skip to content

Commit b889543

Browse files
committed
Do not use Spinx directives in readme, as PyPI doesn't like them
1 parent 50e8c48 commit b889543

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
===================
2-
minfraud-api-python
3-
===================
1+
======================================
2+
minFraud Score and Insights Python API
3+
======================================
44

55
Description
66
-----------
@@ -55,7 +55,7 @@ fields are optional.
5555

5656
Assuming validation has not been disabled, before sending the transaction to
5757
the web service, the transaction dictionary structure and content will be
58-
validated. If validation fails, a :class:`minfraud.InvalidRequestError`
58+
validated. If validation fails, a ``minfraud.InvalidRequestError``
5959
will be raised.
6060

6161
If the dictionary is valid, a request will be made to the web service. If the
@@ -67,18 +67,18 @@ Errors
6767

6868
The possible errors are:
6969

70-
* :class:`minfraud.AuthenticationError` - This will be raised when the server
70+
* ``minfraud.AuthenticationError`` - This will be raised when the server
7171
is unable to authenticate the request, e.g., if the license key or user ID
7272
is invalid.
73-
* :class:`minfraud.InsufficientFundsError` - This will be raised when `your
73+
* ``minfraud.InsufficientFundsError`` - This will be raised when `your
7474
account <https://www.maxmind.com/en/account>`_ is out of funds.
75-
* :class:`minfraud.InvalidRequestError` - This will be raised when the server
75+
* ``minfraud.InvalidRequestError`` - This will be raised when the server
7676
rejects the request as invalid for another reason, such as a missing or
7777
reserved IP address. It is also raised if validation of the request before
7878
it is sent to the server fails.
79-
* :class:`minfraud.HttpError` - This will be raised when an unexpected HTTP
79+
* ``minfraud.HttpError`` - This will be raised when an unexpected HTTP
8080
error occurs such as a firewall interfering with the request to the server.
81-
* :class:`minfraud.MinFraudError` - This will be raised when some other error
81+
* ``minfraud.MinFraudError`` - This will be raised when some other error
8282
occurs such as unexpected content from the server. This also serves as the
8383
base class for the above errors.
8484

0 commit comments

Comments
 (0)