From 282b836e8016dc18e9758a20d904bd143e8403fd Mon Sep 17 00:00:00 2001 From: Harmon Date: Wed, 7 Apr 2021 12:24:37 -0500 Subject: [PATCH] Add and use substitution for stringify_ids parameter documentation --- docs/parameters.rst | 1 + tweepy/api.py | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/parameters.rst b/docs/parameters.rst index 6240053..13f2765 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -26,6 +26,7 @@ .. |since_id| replace:: Returns only statuses with an ID greater than (that is, more recent than) the specified ID. .. |skip_status| replace:: A boolean indicating whether 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. +.. |stringify_ids| replace:: Have IDs returned as strings instead .. |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. diff --git a/tweepy/api.py b/tweepy/api.py index 5cb0413..48e74b3 100644 --- a/tweepy/api.py +++ b/tweepy/api.py @@ -479,7 +479,7 @@ class API: :param id: |sid| :param count: |count| :param cursor: |cursor| - :param stringify_ids: Have IDs returned as strings instead + :param stringify_ids: |stringify_ids| :rtype: list of :class:`int` @@ -1394,7 +1394,7 @@ class API: :param user_id: |user_id| :param screen_name: |screen_name| :param cursor: |cursor| - :param stringify_ids: Have IDs returned as strings instead + :param stringify_ids: |stringify_ids| :param count: |count| :rtype: list of :class:`int` @@ -1445,7 +1445,7 @@ class API: :param user_id: |user_id| :param screen_name: |screen_name| :param cursor: |cursor| - :param stringify_ids: Have IDs returned as strings instead + :param stringify_ids: |stringify_ids| :param count: |count| :rtype: list of :class:`int` -- 2.25.1