Update and improve documentation for API.friends_ids
authorHarmon <Harmon758@gmail.com>
Mon, 24 May 2021 21:50:50 +0000 (16:50 -0500)
committerHarmon <Harmon758@gmail.com>
Mon, 24 May 2021 21:50:50 +0000 (16:50 -0500)
tweepy/api.py

index aac48398eb98463906c3e0acb788fab5219ff8f1..1072c1b5c474d649a3d4a90d5e2121ec3991ce45 100644 (file)
@@ -2099,15 +2099,26 @@ class API:
         Returns an array containing the IDs of users being followed by the
         specified user.
 
-        :param user_id: |user_id|
-        :param screen_name: |screen_name|
-        :param cursor: |cursor|
-        :param stringify_ids: |stringify_ids|
-        :param count: |count|
+        Parameters
+        ----------
+        user_id
+            |user_id|
+        screen_name
+            |screen_name|
+        cursor
+            |cursor|
+        stringify_ids
+            |stringify_ids|
+        count
+            |count|
 
-        :rtype: list of :class:`int`
+        Returns
+        -------
+        :py:class:`List`\ [:class:`int`]
 
-        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids
         """
         return self.request(
             'GET', 'friends/ids', endpoint_parameters=(