mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-11-28 19:22:54 +01:00
42eaa67fd5
Co-authored-by: tsnoam <tsnoam@gmail.com> Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
2.3 KiB
2.3 KiB
Checklist for PRs
- 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
- Documented code changes according to the CSI standard
- Added myself alphabetically to
AUTHORS.rst
(optional) - Added new classes & modules to the docs and all suitable
__all__
s
If the PR contains API changes (otherwise, you can delete this passage)
-
New classes:
- Added
self._id_attrs
and corresponding documentation __init__
accepts**_kwargs
- Added
-
Added new shortcuts:
- In
Chat
&User
for all methods that acceptchat/user_id
- In
Message
for all methods that acceptchat_id
andmessage_id
- For new
Message
shortcuts: Addedquote
argument if methods acceptsreply_to_message_id
- In
CallbackQuery
for all methods that accept eitherchat_id
andmessage_id
orinline_message_id
- In
-
If relevant:
- Added new constants at
telegram.constants
and shortcuts to them as class variables - Link new and existing constants in docstrings instead of hard coded number and strings
- Add new message types to
Message.effective_attachment
- Added new handlers for new update types
- Add the handlers to the warning loop in the
ConversationHandler
- Add the handlers to the warning loop in the
- Added new filters for new message (sub)types
- Added or updated documentation for the changed class(es) and/or method(s)
- Added or updated
bot_methods.rst
- Updated the Bot API version number in all places:
README.rst
andREADME_RAW.rst
(including the badge), as well astelegram.constants.BOT_API_VERSION
- Added logic for arbitrary callback data in
tg.ext.Bot
for new methods that either accept areply_markup
in some form or have a return type that is/containstelegram.Message
- Added new constants at