diff options
Diffstat (limited to 'docs/12_utilities.rst')
| -rw-r--r-- | docs/12_utilities.rst | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/12_utilities.rst b/docs/12_utilities.rst new file mode 100644 index 0000000..9666578 --- /dev/null +++ b/docs/12_utilities.rst | |||
| @@ -0,0 +1,22 @@ | |||
| 1 | Utility: Pagination and Blurhash | ||
| 2 | ================================ | ||
| 3 | .. py:module:: mastodon | ||
| 4 | .. py:class: Mastodon | ||
| 5 | |||
| 6 | Pagination | ||
| 7 | ---------- | ||
| 8 | These functions allow for convenient retrieval of paginated data. | ||
| 9 | |||
| 10 | .. _fetch_next(): | ||
| 11 | .. automethod:: Mastodon.fetch_next | ||
| 12 | .. _fetch_previous(): | ||
| 13 | .. automethod:: Mastodon.fetch_previous | ||
| 14 | .. _fetch_remaining(): | ||
| 15 | .. automethod:: Mastodon.fetch_remaining | ||
| 16 | |||
| 17 | Blurhash decoding | ||
| 18 | ----------------- | ||
| 19 | This function allows for easy basic decoding of blurhash strings to images. | ||
| 20 | This requires Mastodon.pys optional "blurhash" feature dependencies. | ||
| 21 | |||
| 22 | .. automethod:: Mastodon.decode_blurhash | ||