mirror of
https://github.com/boticord/boticordpy.git
synced 2024-11-11 19:07:29 +03:00
update docs
This commit is contained in:
parent
c27521de8b
commit
0b83f7a2ca
3 changed files with 7 additions and 3 deletions
|
@ -24,9 +24,10 @@ class _Webhook(TypedDict):
|
|||
class BoticordWebhook:
|
||||
"""
|
||||
This class is used as a manager for the Boticord webhook.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
bot : :class:`commands.Bot` | :class:`commands.AutoShardedBot`
|
||||
bot: :class:`commands.Bot` | :class:`commands.AutoShardedBot`
|
||||
The discord.py Bot instance
|
||||
"""
|
||||
|
||||
|
@ -45,12 +46,14 @@ class BoticordWebhook:
|
|||
|
||||
def bot_webhook(self, route: str = "/bot", hook_key: str = "") -> "BoticordWebhook":
|
||||
"""This method may be used to configure the route of boticord bot's webhook.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
route: str
|
||||
Bot's webhook route. Must start with ``/``. Defaults - ``/bot``.
|
||||
hook_key: str
|
||||
Webhook authorization key.
|
||||
|
||||
Returns
|
||||
----------
|
||||
:class:`BoticordWebhook`
|
||||
|
@ -91,6 +94,7 @@ class BoticordWebhook:
|
|||
|
||||
def run(self, port: int):
|
||||
"""Runs the webhook.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
port: int
|
||||
|
|
|
@ -18,7 +18,7 @@ This is a documentation for simple python module to work with the boticord api.
|
|||
main
|
||||
modules
|
||||
webhook
|
||||
event_reference
|
||||
reference
|
||||
exceptions
|
||||
|
||||
Links
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
.. currentmodule:: boticordpy
|
||||
|
||||
.. event_reference:
|
||||
.. reference:
|
||||
|
||||
Event Reference
|
||||
---------------
|
Loading…
Reference in a new issue