From: Harmon Date: Sat, 7 May 2022 12:00:09 +0000 (-0500) Subject: Separate Response documentation from Client documentation X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=aef2f734b1621c896e401eb63df49515c231fd6f;p=tweepy.git Separate Response documentation from Client documentation --- diff --git a/docs/client.rst b/docs/client.rst index f2b1b8a..4bf7172 100644 --- a/docs/client.rst +++ b/docs/client.rst @@ -495,15 +495,3 @@ Batch compliance .. automethod:: Client.get_compliance_job .. automethod:: Client.create_compliance_job - -``Response`` -============ -.. autoclass:: Response - :class-doc-from: class - - 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. - - .. versionadded:: 4.0 diff --git a/docs/index.rst b/docs/index.rst index 96db007..63cbba4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -36,6 +36,7 @@ Contents: :caption: Twitter API v2 Reference client.rst + response.rst streamingclient.rst exceptions.rst expansions_and_fields.rst diff --git a/docs/response.rst b/docs/response.rst new file mode 100644 index 0000000..bc9aab3 --- /dev/null +++ b/docs/response.rst @@ -0,0 +1,14 @@ +.. _response: + +.. currentmodule:: tweepy + +``Response`` +============ +.. autoclass:: Response + :class-doc-from: class + + A :class:`collections.namedtuple`, with ``data``, ``includes``, ``errors``, + and ``meta`` fields, corresponding with the fields in responses from + Twitter's API. + + .. versionadded:: 4.0