Skip to content

Commit

Permalink
Separate Response documentation from Client documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Harmon758 committed May 7, 2022
1 parent 8f67aad commit aef2f73
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 12 deletions.
12 changes: 0 additions & 12 deletions docs/client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Contents:
:caption: Twitter API v2 Reference

client.rst
response.rst
streamingclient.rst
exceptions.rst
expansions_and_fields.rst
Expand Down
14 changes: 14 additions & 0 deletions docs/response.rst
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit aef2f73

Please sign in to comment.