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

@ -1,52 +0,0 @@
########
stopPoll
########
Use this method to stop a poll which was sent by the bot. On success, the stopped Poll with the final results is returned.
Returns: :obj:`Poll`
.. automodule:: aiogram.api.methods.stop_poll
:members:
Usage
=====
As bot method
-------------
.. code-block::
result: Poll = await bot.stop_poll(...)
Method as object
----------------
Imports:
- :code:`from aiogram.methods import StopPoll`
- :code:`from aiogram.api.methods import StopPoll`
- :code:`from aiogram.api.methods.stop_poll import StopPoll`
In handlers with current bot
----------------------------
.. code-block::
result: Poll = await StopPoll(...)
With specific bot
~~~~~~~~~~~~~~~~~
.. code-block::
result: Poll = await bot(StopPoll(...))
As reply into Webhook in handler
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block::
return StopPoll(...)