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

index 372c0972deb2a52430f8dfdd12047cc0a60ad498..77802ee2db2a4bfaf193d8f1e23dffb111506062 100644 (file)
@@ -2257,12 +2257,20 @@ class API:
         Returns a collection of numeric IDs for every protected user for whom
         the authenticating user has a pending follow request.
 
-        :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-outgoing
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-outgoing
         """
         return self.request(
             'GET', 'friendships/outgoing', endpoint_parameters=(