TeamPGM/pyrogram
2
0
Fork 0
mirror of https://github.com/TeamPGM/pyrogram.git synced 2024-11-27 16:45:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs improvements

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Makefile
View File

@ -20,4 +20,4 @@ help:
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
lhtml: # live html lhtml: # live html
sphinx-autobuild -H $(shell ipconfig getifaddr en3) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) sphinx-autobuild --host $(shell ifconfig | grep "inet " | grep -v 127.0.0.1 | cut -d\ -f2) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS)

2
docs/source/index.rst
View File

@ -54,7 +54,7 @@ following them in order using the :guilabel:`Next` button at the end of each pag
list of the most relevant pages for a quick access. list of the most relevant pages for a quick access.
.. admonition :: Cloud Credits .. admonition :: Cloud Credits
:class: attention :class: tip
If you need a cloud server to host your applications, we recommend using **Hetzner Cloud**. Sign up with If you need a cloud server to host your applications, we recommend using **Hetzner Cloud**. Sign up with
`this link <https://hetzner.cloud/?ref=9CyT92gZEINU>`_ to get €20 in cloud credits and help support Pyrogram as `this link <https://hetzner.cloud/?ref=9CyT92gZEINU>`_ to get €20 in cloud credits and help support Pyrogram as

9
pyrogram/methods/chats/iter_chat_members.py
View File

@ -57,11 +57,11 @@ class IterChatMembers(Scaffold):
limit (``int``, *optional*): limit (``int``, *optional*):
Limits the number of members to be retrieved. 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 (``str``, *optional*):
Query string to filter members based on their display names and usernames. 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 (``str``, *optional*):
Filter used to select the kind of members you want to retrieve. Only applicable for supergroups 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. *"administrators"* - chat administrators only.
Defaults to *"recent"*. 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: Returns:
``Generator``: A generator yielding :obj:`~pyrogram.types.ChatMember` objects. ``Generator``: A generator yielding :obj:`~pyrogram.types.ChatMember` objects.