Separate Response documentation from Client documentation
authorHarmon <Harmon758@gmail.com>
Sat, 7 May 2022 12:00:09 +0000 (07:00 -0500)
committerHarmon <Harmon758@gmail.com>
Sat, 7 May 2022 12:00:09 +0000 (07:00 -0500)
docs/client.rst
docs/index.rst
docs/response.rst [new file with mode: 0644]

index f2b1b8a88f4c17726eedc00f76ff2abb1c2b5d7c..4bf7172613e23613382ae738cc1c912ea84f35b7 100644 (file)
@@ -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
index 96db00791d69249ff99a9faff1af1897cc8b2732..63cbba4abb4ba1c7e5330fe9254107c6bb748047 100644 (file)
@@ -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 (file)
index 0000000..bc9aab3
--- /dev/null
@@ -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