From: Harmon Date: Tue, 13 Apr 2021 02:06:16 +0000 (-0500) Subject: Document Response X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=5582137df95bd5d27d9c872ac8893646aef19ce6;p=tweepy.git Document Response --- diff --git a/docs/client.rst b/docs/client.rst index dcbc1d5..1dd2d5f 100644 --- a/docs/client.rst +++ b/docs/client.rst @@ -190,3 +190,11 @@ user data objects. .. _poll fields: https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/poll .. _Tweet fields: https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/tweet .. _user fields: https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/user + +.. _response_reference: + +``Response`` +============ +The :obj:`Response` returned by :class:`Client` methods is a +:class:`collections.namedtuple`, with ``data``, ``includes``, ``errors``, and +``meta`` fields, corresponding with the fields in responses from Twitter's API. diff --git a/tweepy/client.py b/tweepy/client.py index 418a665..7befd56 100644 --- a/tweepy/client.py +++ b/tweepy/client.py @@ -286,7 +286,7 @@ class Client: Returns ------- - Response + :ref:`response_reference` References ---------- @@ -376,7 +376,7 @@ class Client: Returns ------- - Response + :ref:`response_reference` References ---------- @@ -480,7 +480,7 @@ class Client: Returns ------- - Response + :ref:`response_reference` References ---------- @@ -588,7 +588,7 @@ class Client: Returns ------- - Response + :ref:`response_reference` References ---------- @@ -638,7 +638,7 @@ class Client: Returns ------- - Response + :ref:`response_reference` References ---------- @@ -682,7 +682,7 @@ class Client: Returns ------- - Response + :ref:`response_reference` References ---------- @@ -712,7 +712,7 @@ class Client: Returns ------- - Response + :ref:`response_reference` References ---------- @@ -756,7 +756,7 @@ class Client: Returns ------- - Response + :ref:`response_reference` References ---------- @@ -804,7 +804,7 @@ class Client: Returns ------- - Response + :ref:`response_reference` References ---------- @@ -835,7 +835,7 @@ class Client: Returns ------- - Response + :ref:`response_reference` References ---------- @@ -880,7 +880,7 @@ class Client: Returns ------- - Response + :ref:`response_reference` References ---------- @@ -939,7 +939,7 @@ class Client: Returns ------- - Response + :ref:`response_reference` References ----------