Add trim_user to documented parameters
authorHarmon <Harmon758@gmail.com>
Sun, 1 Sep 2019 20:19:30 +0000 (15:19 -0500)
committerHarmon <Harmon758@gmail.com>
Sun, 1 Sep 2019 20:19:30 +0000 (15:19 -0500)
docs/api.rst
docs/parameters.rst

index 184b7092f9cc4131fd0cf5963f77edfb13abae52..8d03a42887cb7135d76fe36029626e5a3058eca2 100644 (file)
@@ -67,8 +67,7 @@ Timeline methods
 
    :param id_: A list of Tweet IDs to lookup, up to 100
    :param include_entities: |include_entities|
-   :param trim_user: A boolean indicating if user IDs should be provided,
-                     instead of full user information. Defaults to False.
+   :param trim_user: |trim_user|
    :param map_: A boolean indicating whether or not to include tweets that
                 cannot be shown. Defaults to False.
    :rtype: list of :class:`Status` objects
@@ -184,9 +183,7 @@ Status methods
    :param place_id: A place in the world.
    :param display_coordinates: Whether or not to put a pin on the exact
       coordinates a Tweet has been sent from.
-   :param trim_user: When set to either true, t, or 1, the response will
-      include a user object including only the author's ID. Omit this
-      parameter to receive the complete user object.
+   :param trim_user: |trim_user|
    :param enable_dmcommands: When set to true, enables shortcode commands for
       sending Direct Messages as part of the status text to send a Direct
       Message to a user. When set to false, disables this behavior and includes
index 5b8a62c53834f2456adb1dd536775203f6f2f781..db20c15d4c7f5b31ca7af13e5fb188e0ff65675a 100644 (file)
@@ -19,6 +19,7 @@
 .. |since_id| replace:: Returns only statuses with an ID greater than (that is, more recent than) the specified ID.
 .. |skip_status| replace:: When set to either true, t or 1 statuses will not be included in the returned user objects. Defaults to false.
 .. |slug| replace:: You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you'll also have to specify the list owner using the owner_id or owner_screen_name parameters.
+.. |trim_user| replace:: A boolean indicating if user IDs should be provided, instead of complete user objects. Defaults to False.
 .. |uid| replace:: Specifies the ID or screen name of the user.
 .. |user_id| replace:: Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.