Skip to content

Commit 8fbe45d

Browse files
committed
Docs improvements
1 parent 30664b2 commit 8fbe45d

File tree

3 files changed

+9
-4
lines changed

3 files changed

+9
-4
lines changed

docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ help:
2020
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
2121

2222
lhtml: # live html
23-
sphinx-autobuild -H $(shell ipconfig getifaddr en3) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS)
23+
sphinx-autobuild --host $(shell ifconfig | grep "inet " | grep -v 127.0.0.1 | cut -d\ -f2) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS)

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ following them in order using the :guilabel:`Next` button at the end of each pag
5454
list of the most relevant pages for a quick access.
5555

5656
.. admonition :: Cloud Credits
57-
:class: attention
57+
:class: tip
5858
5959
If you need a cloud server to host your applications, we recommend using **Hetzner Cloud**. Sign up with
6060
`this link <https://hetzner.cloud/?ref=9CyT92gZEINU>`_ to get €20 in cloud credits and help support Pyrogram as

pyrogram/methods/chats/iter_chat_members.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,11 @@ async def iter_chat_members(
5757
5858
limit (``int``, *optional*):
5959
Limits the number of members to be retrieved.
60-
By default, no limit is applied and all members are returned.
60+
By default, no limit is applied and all members are returned [1]_.
6161
6262
query (``str``, *optional*):
6363
Query string to filter members based on their display names and usernames.
64-
Defaults to "" (empty string).
64+
Defaults to "" (empty string) [2]_.
6565
6666
filter (``str``, *optional*):
6767
Filter used to select the kind of members you want to retrieve. Only applicable for supergroups
@@ -74,6 +74,11 @@ async def iter_chat_members(
7474
*"administrators"* - chat administrators only.
7575
Defaults to *"recent"*.
7676
77+
.. [1] Server limit: on supergroups, you can get up to 10,000 members for a single query and up to 200 members
78+
on channels.
79+
80+
.. [2] A query string is applicable only for *"all"*, *"kicked"* and *"restricted"* filters only.
81+
7782
Returns:
7883
``Generator``: A generator yielding :obj:`~pyrogram.types.ChatMember` objects.
7984

0 commit comments

Comments
 (0)