From a6d974b69be103fa7e863ce4a348b3b0b9fe6ed1 Mon Sep 17 00:00:00 2001
From: codl <codl@codl.fr>
Date: Sun, 16 Apr 2023 21:12:06 +0200
Subject: [PATCH] doc: warn against using max_id in favourites/bookmarks

see #335
---
 mastodon/favourites.py | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/mastodon/favourites.py b/mastodon/favourites.py
index 9d86424..35d7782 100644
--- a/mastodon/favourites.py
+++ b/mastodon/favourites.py
@@ -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)
-        
\ No newline at end of file
+