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

index 703d29b59eec12c33580e7ddca866101b6c504fc..6b035829fa35b20141ea3ea0351bffc92a8e5f50 100644 (file)
@@ -2201,14 +2201,20 @@ class API:
         Returns the relationships of the authenticated user to the list of up
         to 100 screen_name or user_id provided.
 
-        :param screen_name: A list of screen names, up to 100 are allowed in a
-                            single request.
-        :param user_id: A list of user IDs, up to 100 are allowed in a single
-                        request.
+        Parameters
+        ----------
+        screen_name
+            A list of screen names, up to 100 are allowed in a single request.
+        user_id
+            A list of user IDs, up to 100 are allowed in a single request.
 
-        :rtype: list of :class:`Relationship` objects
+        Returns
+        -------
+        :py:class:`List`\ [:class:`~tweepy.models.Relationship`]
 
-        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-lookup
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-lookup
         """
         return self.request(
             'GET', 'friendships/lookup', endpoint_parameters=(