From cbac800b752c7ac063b44e120f9699fd969718de Mon Sep 17 00:00:00 2001 From: Harmon Date: Fri, 9 Apr 2021 13:24:16 -0500 Subject: [PATCH] Document API.get_settings Automatically use docstring for documentation Improve method order Add API documentation header to match API reference index --- docs/api.rst | 5 +++++ tweepy/api.py | 25 +++++++++++++++++-------- 2 files changed, 22 insertions(+), 8 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 8b1743e..668d02b 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -141,6 +141,11 @@ Follow, search, and get users .. automethod:: API.update_friendship +Manage account settings and profile +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automethod:: API.get_settings + Direct Message Methods ---------------------- diff --git a/tweepy/api.py b/tweepy/api.py index 602e34d..474909e 100644 --- a/tweepy/api.py +++ b/tweepy/api.py @@ -1737,6 +1737,23 @@ class API: ), **kwargs ) + # Manage account settings and profile + + @payload('json') + def get_settings(self, **kwargs): + """get_settings() + + Returns settings (including current trend, geo and sleep time + information) for the authenticating user. + + :rtype: :class:`JSON` object + + :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-account-settings + """ + return self.request( + 'GET', 'account/settings', use_cache=False, **kwargs + ) + def media_upload(self, filename, *, file=None, chunked=False, media_category=None, additional_owners=None, **kwargs): """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/overview @@ -1966,14 +1983,6 @@ class API: ), id=id, **kwargs ) - @payload('json') - def get_settings(self, **kwargs): - """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-account-settings - """ - return self.request( - 'GET', 'account/settings', use_cache=False, **kwargs - ) - @payload('json') def set_settings(self, **kwargs): """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-settings -- 2.25.1