lasse/Mastodon.py
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #336 from codl/doc-upd-335

Browse Source 
doc: warn against using max_id in favourites/bookmarks
This commit is contained in:
Lorenz Diener 2023-04-23 18:50:47 +03:00 committed by GitHub
commit ba142e9b44
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
mastodon/favourites.py
View File

@ -14,6 +14,11 @@ class Mastodon(Internals):
""" """
Fetch the logged-in user's favourited statuses. Fetch the logged-in user's favourited statuses.
This endpoint uses internal ids for pagination, passing status ids to
`max_id`, `min_id`, or `since_id` will not work. Pagination functions
:ref:`fetch_next() <fetch_next()>`
and :ref:`fetch_previous() <fetch_previous()>` should be used instead.
Returns a list of :ref:`status dicts <status dicts>`. Returns a list of :ref:`status dicts <status dicts>`.
""" """
if max_id is not None: if max_id is not None:
@ -36,6 +41,11 @@ class Mastodon(Internals):
""" """
Get a list of statuses bookmarked by the logged-in user. Get a list of statuses bookmarked by the logged-in user.
This endpoint uses internal ids for pagination, passing status ids to
`max_id`, `min_id`, or `since_id` will not work. Pagination functions
:ref:`fetch_next() <fetch_next()>`
and :ref:`fetch_previous() <fetch_previous()>` should be used instead.
Returns a list of :ref:`status dicts <status dicts>`. Returns a list of :ref:`status dicts <status dicts>`.
""" """
if max_id is not None: if max_id is not None: