aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst10
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 32d928f..a883e67 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -102,7 +102,12 @@ instance may choose to return less results than you requested.
102The responses returned by paginated endpoints contain a "link" header that specifies 102The responses returned by paginated endpoints contain a "link" header that specifies
103which parameters to use to get the next and previous pages. Mastodon.py parses these 103which parameters to use to get the next and previous pages. Mastodon.py parses these
104and stores them (if present) in the first (for the previous page) and last (for the 104and stores them (if present) in the first (for the previous page) and last (for the
105next page) item of the returned list as _pagination_prev and _pagination_next. 105next page) item of the returned list as _pagination_prev and _pagination_next. They
106are accessible only via attribute-style access, and are not considered in determining
107dict equality (meaning their presence will not affect any tests of wheter two dicts
108are the same, or whether a specific dict is in a list). Note that this also means that
109if you want to persist pagination info with your data, you'll have to take care of that
110manually (or persist objects, not just dicts).
106 111
107There are convenience functions available for fetching the previous and next page of 112There are convenience functions available for fetching the previous and next page of
108a paginated request as well as for fetching all pages starting from a first page. 113a paginated request as well as for fetching all pages starting from a first page.
@@ -188,7 +193,8 @@ you can also just write
188 193
189 description = mastodon.account_verify_credentials().source.note 194 description = mastodon.account_verify_credentials().source.note
190 195
191and everything will work as intended. 196and everything will work as intended. The class used for this is exposed as
197`AttribAccessDict`.
192 198
193 199
194User dicts 200User dicts
Powered by cgit v1.2.3 (git 2.41.0)