Update and improve documentation for API.get_user
authorHarmon <Harmon758@gmail.com>
Mon, 24 May 2021 22:07:10 +0000 (17:07 -0500)
committerHarmon <Harmon758@gmail.com>
Mon, 24 May 2021 22:07:10 +0000 (17:07 -0500)
tweepy/api.py

index 3e2242c93cbd8593caa28d9348ad9a42aa233a6d..27c5d3b8dc0c9799855d3408117d28ebe57296fe 100644 (file)
@@ -2398,13 +2398,22 @@ class API:
 
         Returns information about the specified user.
 
-        :param user_id: |user_id|
-        :param screen_name: |screen_name|
-        :param include_entities: |include_entities|
+        Parameters
+        ----------
+        user_id
+            |user_id|
+        screen_name
+            |screen_name|
+        include_entities
+            |include_entities|
 
-        :rtype: :class:`User` object
+        Returns
+        -------
+        :class:`~tweepy.models.User`
 
-        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-users-show
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-users-show
         """
         return self.request(
             'GET', 'users/show', endpoint_parameters=(