2
0
mirror of https://github.com/pyrogram/pyrogram synced 2025-09-01 06:45:39 +00:00

Docs improvements

This commit is contained in:
Dan
2020-11-27 19:06:25 +01:00
parent 30664b26d5
commit 8fbe45ddba
3 changed files with 9 additions and 4 deletions

View File

@@ -57,11 +57,11 @@ class IterChatMembers(Scaffold):
limit (``int``, *optional*):
Limits the number of members to be retrieved.
By default, no limit is applied and all members are returned.
By default, no limit is applied and all members are returned [1]_.
query (``str``, *optional*):
Query string to filter members based on their display names and usernames.
Defaults to "" (empty string).
Defaults to "" (empty string) [2]_.
filter (``str``, *optional*):
Filter used to select the kind of members you want to retrieve. Only applicable for supergroups
@@ -74,6 +74,11 @@ class IterChatMembers(Scaffold):
*"administrators"* - chat administrators only.
Defaults to *"recent"*.
.. [1] Server limit: on supergroups, you can get up to 10,000 members for a single query and up to 200 members
on channels.
.. [2] A query string is applicable only for *"all"*, *"kicked"* and *"restricted"* filters only.
Returns:
``Generator``: A generator yielding :obj:`~pyrogram.types.ChatMember` objects.