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

doc: warn against using max_id in favourites/bookmarks
pull/306/head^2
Lorenz Diener 2023-04-23 18:50:47 +03:00 zatwierdzone przez GitHub
commit ba142e9b44
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 4AEE18F83AFDEB23
1 zmienionych plików z 11 dodań i 1 usunięć

Wyświetl plik

@ -14,6 +14,11 @@ class Mastodon(Internals):
"""
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>`.
"""
if max_id is not None:
@ -36,6 +41,11 @@ class Mastodon(Internals):
"""
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>`.
"""
if max_id is not None:
@ -49,4 +59,4 @@ class Mastodon(Internals):
params = self.__generate_params(locals())
return self.__api_request('GET', '/api/v1/bookmarks', params)