From: Harmon Date: Fri, 10 May 2019 19:40:15 +0000 (-0500) Subject: Add documentation for API.mutes X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=29bae1fde3ae0636fa13e5ed69f68f2af75c110b;p=tweepy.git Add documentation for API.mutes --- diff --git a/docs/api.rst b/docs/api.rst index 13edabc..a2f753a 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -509,6 +509,16 @@ Mute Methods :rtype: :class:`User` object +.. method:: API.mutes([cursor], [include_entities], [skip_status]) + + Returns an array of user objects the authenticating user has muted. + + :param cursor: |cursor| + :param include_entities: |include_entities| + :param skip_status: |skip_status| + :rtype: list of :class:`User` objects + + .. method:: API.mutes_ids([cursor]) Returns an array of numeric user ids the authenticating user has muted. diff --git a/docs/parameters.rst b/docs/parameters.rst index 313fde4..5b8a62c 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -5,6 +5,7 @@ .. |date| replace:: Permits specifying a start date for the report. The date should be formatted YYYY-MM-DD. .. |exclude| replace:: Setting this equal to hashtags will remove all hashtags from the trends list. .. |full_text| replace:: A boolean indicating whether or not the full text of a message should be returned. If False the message text returned will be truncated to 140 chars. Defaults to False. +.. |include_entities| replace:: The entities node will not be included when set to false. Defaults to true. .. |include_user_entities| replace:: The user object entities node will not be included when set to false. Defaults to true. .. |list_id| replace:: The numerical id of the list. .. |list_mode| replace:: Whether your list is public or private. Values can be public or private. Lists are public by default if no mode is specified.