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

index aac1b74560574868f555fa96b9a5c8d72a009656..703d29b59eec12c33580e7ddca866101b6c504fc 100644 (file)
@@ -2173,12 +2173,20 @@ class API:
         Returns a collection of numeric IDs for every user who has a pending
         request to follow the authenticating user.
 
-        :param cursor: |cursor|
-        :param stringify_ids: |stringify_ids|
+        Parameters
+        ----------
+        cursor
+            |cursor|
+        stringify_ids
+            |stringify_ids|
 
-        :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-friendships-incoming
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming
         """
         return self.request(
             'GET', 'friendships/incoming', endpoint_parameters=(