aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorhalcy <halcy@ARARAGI-KUN>2022-11-28 01:45:00 +0200
committerhalcy <halcy@ARARAGI-KUN>2022-11-28 01:45:00 +0200
commitbd3db974d771d753e7732fabe6a050b779c466e2 (patch)
treea930b779e62b731ec041cab02a484cbdf9ce3099 /docs
parent10d48d702d71add36d44e3db54bd7b38766bad15 (diff)
downloadmastodon.py-bd3db974d771d753e7732fabe6a050b779c466e2.tar.gz
add module / class stuff
Diffstat (limited to 'docs')
-rw-r--r--docs/01_general.rst2
-rw-r--r--docs/02_return_values.rst2
-rw-r--r--docs/03_errors.rst3
-rw-r--r--docs/04_auth.rst2
4 files changed, 9 insertions, 0 deletions
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 @@
1General information 1General information
2=================== 2===================
3.. py:module:: mastodon
4.. py:class: Mastodon
3 5
4Rate limiting 6Rate limiting
5------------- 7-------------
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 @@
1Return values 1Return values
2============= 2=============
3.. py:module:: mastodon
4.. py:class: Mastodon
3 5
4Unless otherwise specified, all data is returned as Python dictionaries, matching 6Unless otherwise specified, all data is returned as Python dictionaries, matching
5the JSON format used by the API. Dates returned by the API are in ISO 8601 format 7the 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 @@
1Error handling 1Error handling
2============== 2==============
3.. py:module:: mastodon
4.. py:class: Mastodon
5
3When Mastodon.py encounters an error, it will raise an exception, generally with 6When Mastodon.py encounters an error, it will raise an exception, generally with
4some text included to tell you what went wrong. 7some text included to tell you what went wrong.
5 8
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 @@
1App registration and user authentication 1App registration and user authentication
2======================================== 2========================================
3.. py:module:: mastodon
4.. py:class: Mastodon
3 5
4Before you can use the Mastodon API, you have to register your 6Before you can use the Mastodon API, you have to register your
5application (which gets you a client key and client secret) 7application (which gets you a client key and client secret)
Powered by cgit v1.2.3 (git 2.41.0)