Rename API.favorites to API.get_favorites

tweepy · Jun 3, 2021 · 3c467da · 3c467da
1 parent 1400065
commit 3c467da
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/cassettes/testfavorites.json → cassettes/testgetfavorites.json b/cassettes/testfavorites.json → cassettes/testgetfavorites.json
diff --git a/docs/api.rst b/docs/api.rst
@@ -34,7 +34,7 @@
     +------------------------------------------+--------------------------------------+
     | .. centered:: |Post, retrieve, and engage with Tweets|_                         |
     +------------------------------------------+--------------------------------------+
-    | `GET favorites/list`_                    | :meth:`API.favorites`                |
+    | `GET favorites/list`_                    | :meth:`API.get_favorites`            |
     +------------------------------------------+--------------------------------------+
     | `GET statuses/lookup`_                   | :meth:`API.lookup_statuses`          |
     +------------------------------------------+--------------------------------------+
@@ -390,7 +390,7 @@ Get Tweet timelines
 Post, retrieve, and engage with Tweets
 --------------------------------------
 
-.. automethod:: API.favorites
+.. automethod:: API.get_favorites
 
 .. automethod:: API.lookup_statuses
 

diff --git a/tests/test_api.py b/tests/test_api.py
@@ -237,9 +237,9 @@ def testupdateprofile(self):
             if k == 'email': continue
             self.assertEqual(getattr(updated, k), v)
 
-    @tape.use_cassette('testfavorites.json')
-    def testfavorites(self):
-        self.api.favorites()
+    @tape.use_cassette('testgetfavorites.json')
+    def testgetfavorites(self):
+        self.api.get_favorites()
 
     @tape.use_cassette('testcreatedestroyfavorite.json')
     def testcreatedestroyfavorite(self):

diff --git a/tweepy/api.py b/tweepy/api.py
@@ -579,8 +579,8 @@ def user_timeline(self, **kwargs):
 
     @pagination(mode='id')
     @payload('status', list=True)
-    def favorites(self, **kwargs):
-        """favorites(*, user_id, screen_name, count, since_id, max_id, \
+    def get_favorites(self, **kwargs):
+        """get_favorites(*, user_id, screen_name, count, since_id, max_id, \
                      include_entities)
 
         Returns the favorite statuses for the authenticating user or user