Add documentation for API.mutes
authorHarmon <Harmon758@gmail.com>
Fri, 10 May 2019 19:40:15 +0000 (14:40 -0500)
committerHarmon <Harmon758@gmail.com>
Fri, 10 May 2019 19:40:15 +0000 (14:40 -0500)
docs/api.rst
docs/parameters.rst

index 13edabc031faeba965f60693b7b129b5fe3413ee..a2f753a839ed8ab23f61606cf2733060a36080e0 100644 (file)
@@ -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.
index 313fde4ae5ede05ce86a5d25320f32307db1fd82..5b8a62c53834f2456adb1dd536775203f6f2f781 100644 (file)
@@ -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.