From 8b3ea5ce561fbe13e6d739294b80a3366730b850 Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Mon, 8 Nov 2021 19:56:57 +0100 Subject: [PATCH] Add ChatJoinRequest(Handler) to Docs (#2771) --- .github/pull_request_template.md | 1 + docs/source/telegram.chatjoinrequest.rst | 8 ++++++++ docs/source/telegram.ext.chatjoinrequesthandler.rst | 8 ++++++++ docs/source/telegram.ext.rst | 3 ++- docs/source/telegram.rst | 1 + telegram/ext/chatjoinrequesthandler.py | 2 +- 6 files changed, 21 insertions(+), 2 deletions(-) create mode 100644 docs/source/telegram.chatjoinrequest.rst create mode 100644 docs/source/telegram.ext.chatjoinrequesthandler.rst diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index aa027df29..0e6690e6f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -7,6 +7,7 @@ Hey! You're PRing? Cool! Please have a look at the below checklist. It's here to - [ ] Added `.. versionadded:: version`, `.. versionchanged:: version` or `.. deprecated:: version` to the docstrings for user facing changes (for methods/class descriptions, arguments and attributes) - [ ] Created new or adapted existing unit tests - [ ] Added myself alphabetically to `AUTHORS.rst` (optional) +- [ ] Added new classes & modules to the docs ### If the PR contains API changes (otherwise, you can delete this passage) diff --git a/docs/source/telegram.chatjoinrequest.rst b/docs/source/telegram.chatjoinrequest.rst new file mode 100644 index 000000000..401173845 --- /dev/null +++ b/docs/source/telegram.chatjoinrequest.rst @@ -0,0 +1,8 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatjoinrequest.py + +telegram.ChatJoinRequest +======================== + +.. autoclass:: telegram.ChatJoinRequest + :members: + :show-inheritance: diff --git a/docs/source/telegram.ext.chatjoinrequesthandler.rst b/docs/source/telegram.ext.chatjoinrequesthandler.rst new file mode 100644 index 000000000..650ff1b35 --- /dev/null +++ b/docs/source/telegram.ext.chatjoinrequesthandler.rst @@ -0,0 +1,8 @@ +:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/chatjoinrequesthandler.py + +telegram.ext.ChatJoinRequestHandler +=================================== + +.. autoclass:: telegram.ext.ChatJoinRequestHandler + :members: + :show-inheritance: diff --git a/docs/source/telegram.ext.rst b/docs/source/telegram.ext.rst index f4b7bceb0..98b4417e8 100644 --- a/docs/source/telegram.ext.rst +++ b/docs/source/telegram.ext.rst @@ -22,8 +22,9 @@ Handlers telegram.ext.handler telegram.ext.callbackqueryhandler - telegram.ext.choseninlineresulthandler + telegram.ext.chatjoinrequesthandler telegram.ext.chatmemberhandler + telegram.ext.choseninlineresulthandler telegram.ext.commandhandler telegram.ext.conversationhandler telegram.ext.inlinequeryhandler diff --git a/docs/source/telegram.rst b/docs/source/telegram.rst index 39d8a6b13..1dc0a8574 100644 --- a/docs/source/telegram.rst +++ b/docs/source/telegram.rst @@ -19,6 +19,7 @@ telegram package telegram.chat telegram.chataction telegram.chatinvitelink + telegram.chatjoinrequest telegram.chatlocation telegram.chatmember telegram.chatmemberowner diff --git a/telegram/ext/chatjoinrequesthandler.py b/telegram/ext/chatjoinrequesthandler.py index 693b73e47..2a00f0562 100644 --- a/telegram/ext/chatjoinrequesthandler.py +++ b/telegram/ext/chatjoinrequesthandler.py @@ -41,7 +41,7 @@ class ChatJoinRequestHandler(Handler[Update, CCT]): When setting ``run_async`` to :obj:`True`, you cannot rely on adding custom attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info. - .. versionadded:: 13.8 + .. versionadded:: 13.8 Args: callback (:obj:`callable`): The callback function for this handler. Will be called when