From bd3db974d771d753e7732fabe6a050b779c466e2 Mon Sep 17 00:00:00 2001 From: halcy Date: Mon, 28 Nov 2022 01:45:00 +0200 Subject: add module / class stuff --- docs/01_general.rst | 2 ++ docs/02_return_values.rst | 2 ++ docs/03_errors.rst | 3 +++ docs/04_auth.rst | 2 ++ 4 files changed, 9 insertions(+) (limited to 'docs') diff --git a/docs/01_general.rst b/docs/01_general.rst index f16dfb6..e0c3719 100644 --- a/docs/01_general.rst +++ b/docs/01_general.rst @@ -1,5 +1,7 @@ General information =================== +.. py:module:: mastodon +.. py:class: Mastodon Rate limiting ------------- diff --git a/docs/02_return_values.rst b/docs/02_return_values.rst index 52947e9..9cc1e77 100644 --- a/docs/02_return_values.rst +++ b/docs/02_return_values.rst @@ -1,5 +1,7 @@ Return values ============= +.. py:module:: mastodon +.. py:class: Mastodon Unless otherwise specified, all data is returned as Python dictionaries, matching the JSON format used by the API. Dates returned by the API are in ISO 8601 format diff --git a/docs/03_errors.rst b/docs/03_errors.rst index fce7af7..c129783 100644 --- a/docs/03_errors.rst +++ b/docs/03_errors.rst @@ -1,5 +1,8 @@ Error handling ============== +.. py:module:: mastodon +.. py:class: Mastodon + When Mastodon.py encounters an error, it will raise an exception, generally with some text included to tell you what went wrong. diff --git a/docs/04_auth.rst b/docs/04_auth.rst index 454d6a2..1a05603 100644 --- a/docs/04_auth.rst +++ b/docs/04_auth.rst @@ -1,5 +1,7 @@ App registration and user authentication ======================================== +.. py:module:: mastodon +.. py:class: Mastodon Before you can use the Mastodon API, you have to register your application (which gets you a client key and client secret) -- cgit v1.2.3