From: Harmon <Harmon758@gmail.com>
Date: Tue, 25 May 2021 10:47:34 +0000 (-0500)
Subject: Update and improve documentation for API.verify_credentials
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=52af990d45e13ae4a544c97ed82c11f2076ba1a7;p=tweepy.git

Update and improve documentation for API.verify_credentials
---

diff --git a/tweepy/api.py b/tweepy/api.py
index fa8d5dc..893e78f 100644
--- a/tweepy/api.py
+++ b/tweepy/api.py
@@ -2537,14 +2537,28 @@ class API:
 
         Verify the supplied user credentials are valid.
 
-        :param include_entities: |include_entities|
-        :param skip_status: |skip_status|
-        :param include_email: When set to true email will be returned in the
-                              user objects as a string.
+        Parameters
+        ----------
+        include_entities
+            |include_entities|
+        skip_status
+            |skip_status|
+        include_email
+            When set to true email will be returned in the user objects as a
+            string.
 
-        :rtype: :class:`User` object if credentials are valid, otherwise False
+        Raises
+        ------
+        :class:`~tweepy.errors.Unauthorized`
+            Authentication unsuccessful
+
+        Returns
+        -------
+        :class:`~tweepy.models.User`
 
-        :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials
+        References
+        ----------
+        https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials
         """
         if 'include_email' in kwargs:
             kwargs['include_email'] = str(kwargs['include_email']).lower()