Skip to content

Commit dc464c9

Browse files
formatting
1 parent 911801f commit dc464c9

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

Diff for: README.rst

+16-16
Original file line numberDiff line numberDiff line change
@@ -97,29 +97,29 @@ This library is maintained by one busy developer in his spare time, with very li
9797

9898
If you have a problem using this library, the first thing to do is to try to isolate where the problem is. The IG platform is a complex application, and there are many ways to make mistakes using it. Just because you see an error, it does not necessarily mean there is a problem with this library. If you encounter an issue, you should follow these steps, in order:
9999

100-
1. Check if there a problem with the IG platform. From time to time the IG platform itself has issues, especially the DEMO environment. If you see a message like `ConnectionRefusedError`, or a 500 Server error, then it could be an issue with the IG platform. IG provide a `status page <https://status.ig.com/>`_, though its accuracy is questionable. You can also check the `IG Community forums <https://community.ig.com/>`__. If there are platform issues, its likely someone will have already posted a message there.
100+
1 - Check if there a problem with the IG platform. From time to time the IG platform itself has issues, especially the DEMO environment. If you see a message like `ConnectionRefusedError`, or a 500 Server error, then it could be an issue with the IG platform. IG provide a `status page <https://status.ig.com/>`_, though its accuracy is questionable. You can also check the `IG Community forums <https://community.ig.com/>`__. If there are platform issues, its likely someone will have already posted a message there.
101101

102-
2. Check if there is a problem with your code. Most of the API endpoints have multiple options, multiple versions, multiple ways of accessing them, and multiple interdependent parameters. Incoming data is validated on the server, and problems will be reported back in the response. You should
102+
2 - Check if there is a problem with your code. Most of the API endpoints have multiple options, multiple versions, multiple ways of accessing them, and multiple interdependent parameters. Incoming data is validated on the server, and problems will be reported back in the response. You should
103103

104-
* check the documentation (`REST <https://labs.ig.com/rest-trading-api-reference>`__, `Streaming <https://labs.ig.com/streaming-api-reference>`__) to make sure you are calling the APIs correctly
105-
* look at the `sample code <https://github.com/ig-python/trading-ig/tree/master/sample>`_ and `unit and integration tests <https://github.com/ig-python/trading-ig/tree/master/tests>`_. There are example snippets for most API endpoints.
106-
* repeat the API call using the IG companion tools (`REST <https://labs.ig.com/sample-apps/api-companion/index.html>`__, `Streaming <https://labs.ig.com/sample-apps/streaming-companion/index.html>`__). If you get the same result, then it is likely that you are using the API incorrectly.
104+
* check the documentation (`REST <https://labs.ig.com/rest-trading-api-reference>`__, `Streaming <https://labs.ig.com/streaming-api-reference>`__) to make sure you are calling the APIs correctly
105+
* look at the `sample code <https://github.com/ig-python/trading-ig/tree/master/sample>`_ and `unit and integration tests <https://github.com/ig-python/trading-ig/tree/master/tests>`_. There are example snippets for most API endpoints.
106+
* repeat the API call using the IG companion tools (`REST <https://labs.ig.com/sample-apps/api-companion/index.html>`__, `Streaming <https://labs.ig.com/sample-apps/streaming-companion/index.html>`__). If you get the same result, then it is likely that you are using the API incorrectly.
107107

108-
In this case you should:
108+
In this case you should:
109109

110-
* read the IG docs more carefully, or
111-
* post a question in the `IG Community site <https://community.ig.com/>`__, or
112-
* contact the `API support team <mailto:[email protected]>`_
110+
* read the IG docs more carefully, or
111+
* post a question in the `IG Community site <https://community.ig.com/>`__, or
112+
* contact the `API support team <mailto:[email protected]>`_
113113

114-
3. If you're sure that the problem is with this library, please:
114+
3 - If you're sure that the problem is with this library, please:
115115

116-
* provide *everything* necessary to reproduce the problem
117-
* include the full script that produces the error, including import statements
118-
* ideally this should be a *minimal example* - the shortest possible script that reproduces the problem
119-
* dependencies and their versions
120-
* the full output trace including the error messages
116+
* provide *everything* necessary to reproduce the problem
117+
* include the full script that produces the error, including import statements
118+
* ideally this should be a *minimal example* - the shortest possible script that reproduces the problem
119+
* dependencies and their versions
120+
* the full output trace including the error messages
121121

122-
An issue without all this information may be ignored and/or closed without response
122+
An issue without all this information may be ignored and/or closed without response
123123

124124
Docs
125125
----

0 commit comments

Comments
 (0)