Add docs for Dispatcher

This commit is contained in:
Alex Root Junior 2020-06-27 19:46:01 +03:00
parent 8ebbfb1388
commit 7245811c3c
197 changed files with 872 additions and 19 deletions

View file

@ -0,0 +1,55 @@
###############
editMessageText
###############
Use this method to edit text and game messages. On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
Returns: :obj:`Union[Message, bool]`
.. automodule:: aiogram.api.methods.edit_message_text
:members:
:member-order: bysource
:special-members: __init__
:undoc-members: True
Usage
=====
As bot method
-------------
.. code-block::
result: Union[Message, bool] = await bot.edit_message_text(...)
Method as object
----------------
Imports:
- :code:`from aiogram.methods import EditMessageText`
- :code:`from aiogram.api.methods import EditMessageText`
- :code:`from aiogram.api.methods.edit_message_text import EditMessageText`
In handlers with current bot
----------------------------
.. code-block::
result: Union[Message, bool] = await EditMessageText(...)
With specific bot
~~~~~~~~~~~~~~~~~
.. code-block::
result: Union[Message, bool] = await bot(EditMessageText(...))
As reply into Webhook in handler
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block::
return EditMessageText(...)