Skip to content

Commit 16089c5

Browse files
author
Brandon Black
committed
[docs] adding error hierarchy diagram to readme
1 parent 44e65c3 commit 16089c5

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

README.rst

+13
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,14 @@ Found an issue? Please open up a `GitHub issue`_ or even better yet
102102
`send us`_ a pull request. Have a question? Want to discuss a new
103103
feature? Come chat with us in the `Twitter Community Forums`_.
104104

105+
Error Handling
106+
--------------
107+
108+
Like the `Response`_ and `Request`_ classes, the Ads API SDK fully models
109+
all `error objects`_ for easy error handling.
110+
111+
|error-hierarchy|
112+
105113
License
106114
-------
107115

@@ -141,3 +149,8 @@ SOFTWARE.
141149
:target: https://codeclimate.com/github/twitterdev/twitter-python-ads-sdk
142150
.. |PyPy Version| image:: https://badge.fury.io/py/twitter-ads.svg
143151
:target: http://badge.fury.io/py/twitter-ads
152+
153+
.. _Request: https://github.com/twitterdev/twitter-python-ads-sdk/blob/master/twitter_ads/http.py#L28
154+
.. _Response: https://github.com/twitterdev/twitter-python-ads-sdk/blob/master/twitter_ads/http.py#L118
155+
.. _error objects: https://github.com/twitterdev/twitter-python-ads-sdk/blob/master/twitter_ads/error.py
156+
.. |error-hierarchy| image:: http://i.imgur.com/XcLDWLO.png

error-hierarchy.png

120 KB
Loading

0 commit comments

Comments
 (0)