Add ChatJoinRequest(Handler) to Docs (#2771)

This commit is contained in:
Bibo-Joshi 2021-11-08 19:56:57 +01:00 committed by GitHub
parent 51a4a6664c
commit 8b3ea5ce56
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 21 additions and 2 deletions

View file

@ -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) - [ ] 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 - [ ] Created new or adapted existing unit tests
- [ ] Added myself alphabetically to `AUTHORS.rst` (optional) - [ ] 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) ### If the PR contains API changes (otherwise, you can delete this passage)

View file

@ -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:

View file

@ -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:

View file

@ -22,8 +22,9 @@ Handlers
telegram.ext.handler telegram.ext.handler
telegram.ext.callbackqueryhandler telegram.ext.callbackqueryhandler
telegram.ext.choseninlineresulthandler telegram.ext.chatjoinrequesthandler
telegram.ext.chatmemberhandler telegram.ext.chatmemberhandler
telegram.ext.choseninlineresulthandler
telegram.ext.commandhandler telegram.ext.commandhandler
telegram.ext.conversationhandler telegram.ext.conversationhandler
telegram.ext.inlinequeryhandler telegram.ext.inlinequeryhandler

View file

@ -19,6 +19,7 @@ telegram package
telegram.chat telegram.chat
telegram.chataction telegram.chataction
telegram.chatinvitelink telegram.chatinvitelink
telegram.chatjoinrequest
telegram.chatlocation telegram.chatlocation
telegram.chatmember telegram.chatmember
telegram.chatmemberowner telegram.chatmemberowner

View file

@ -41,7 +41,7 @@ class ChatJoinRequestHandler(Handler[Update, CCT]):
When setting ``run_async`` to :obj:`True`, you cannot rely on adding custom 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. attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info.
.. versionadded:: 13.8 .. versionadded:: 13.8
Args: Args:
callback (:obj:`callable`): The callback function for this handler. Will be called when callback (:obj:`callable`): The callback function for this handler. Will be called when