From 8fbe45ddbaee279819a587f2b9eb0e1e21019a0c Mon Sep 17 00:00:00 2001 From: Dan <14043624+delivrance@users.noreply.github.com> Date: Fri, 27 Nov 2020 19:06:25 +0100 Subject: [PATCH] Docs improvements --- docs/Makefile | 2 +- docs/source/index.rst | 2 +- pyrogram/methods/chats/iter_chat_members.py | 9 +++++++-- 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index cabe3ecb..ceb7494c 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -20,4 +20,4 @@ help: @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 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) diff --git a/docs/source/index.rst b/docs/source/index.rst index 18c69412..c3727360 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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. .. 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 `this link `_ to get €20 in cloud credits and help support Pyrogram as diff --git a/pyrogram/methods/chats/iter_chat_members.py b/pyrogram/methods/chats/iter_chat_members.py index 59def3c1..78254872 100644 --- a/pyrogram/methods/chats/iter_chat_members.py +++ b/pyrogram/methods/chats/iter_chat_members.py @@ -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.