Rename API.list_direct_messages to API.get_direct_messages

tweepy · May 28, 2021 · ff1186f · ff1186f
1 parent b765aee
commit ff1186f
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/cassettes/testlistdirectmessages.json → cassettes/testgetdirectmessages.json b/cassettes/testlistdirectmessages.json → cassettes/testgetdirectmessages.json
diff --git a/docs/api.rst b/docs/api.rst
@@ -192,7 +192,7 @@
     +------------------------------------------+-------------------------------------+
     | `DELETE direct_messages/events/destroy`_ | :meth:`API.destroy_direct_message`  |
     +------------------------------------------+-------------------------------------+
-    | `GET direct_messages/events/list`_       | :meth:`API.list_direct_messages`    |
+    | `GET direct_messages/events/list`_       | :meth:`API.get_direct_messages`     |
     +------------------------------------------+-------------------------------------+
     | `GET direct_messages/events/show`_       | :meth:`API.get_direct_message`      |
     +------------------------------------------+-------------------------------------+
@@ -556,7 +556,7 @@ Sending and receiving events
 
 .. automethod:: API.destroy_direct_message
 
-.. automethod:: API.list_direct_messages
+.. automethod:: API.get_direct_messages
 
 .. automethod:: API.get_direct_message
 

diff --git a/tests/test_api.py b/tests/test_api.py
@@ -131,9 +131,9 @@ def check(users):
     def testsearchusers(self):
         self.api.search_users('twitter')
 
-    @tape.use_cassette('testlistdirectmessages.json')
-    def testlistdirectmessages(self):
-        self.api.list_direct_messages()
+    @tape.use_cassette('testgetdirectmessages.json')
+    def testgetdirectmessages(self):
+        self.api.get_direct_messages()
 
     @tape.use_cassette('testsendanddestroydirectmessage.json')
     def testsendanddestroydirectmessage(self):

diff --git a/tweepy/api.py b/tweepy/api.py
@@ -3179,8 +3179,8 @@ def destroy_direct_message(self, id, **kwargs):
 
     @pagination(mode='dm_cursor')
     @payload('direct_message', list=True)
-    def list_direct_messages(self, **kwargs):
-        """list_direct_messages(*, count, cursor)
+    def get_direct_messages(self, **kwargs):
+        """get_direct_messages(*, count, cursor)
 
         Returns all Direct Message events (both sent and received) within the
         last 30 days. Sorted in reverse-chronological order.