mrkrk/boticordpy
1
0
Fork 0
mirror of https://github.com/boticord/boticordpy.git synced 2024-09-23 03:42:01 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

update docs

Browse source
This commit is contained in:
Victor Kotlin 2021-09-12 13:18:22 +03:00
parent c27521de8b
commit 0b83f7a2ca
3 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
boticordpy/webhook.py
View file

@ -24,6 +24,7 @@ class _Webhook(TypedDict):
class BoticordWebhook: class BoticordWebhook:
""" """
This class is used as a manager for the Boticord webhook. This class is used as a manager for the Boticord webhook.
Parameters Parameters
---------- ----------
bot: :class:`commands.Bot` | :class:`commands.AutoShardedBot` bot: :class:`commands.Bot` | :class:`commands.AutoShardedBot`
@ -45,12 +46,14 @@ class BoticordWebhook:
def bot_webhook(self, route: str = "/bot", hook_key: str = "") -> "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. """This method may be used to configure the route of boticord bot's webhook.
Parameters Parameters
---------- ----------
route: str route: str
Bot's webhook route. Must start with ``/``. Defaults - ``/bot``. Bot's webhook route. Must start with ``/``. Defaults - ``/bot``.
hook_key: str hook_key: str
Webhook authorization key. Webhook authorization key.
Returns Returns
---------- ----------
:class:`BoticordWebhook` :class:`BoticordWebhook`
@ -91,6 +94,7 @@ class BoticordWebhook:
def run(self, port: int): def run(self, port: int):
"""Runs the webhook. """Runs the webhook.
Parameters Parameters
---------- ----------
port: int port: int

2
docs/index.rst
View file

@ -18,7 +18,7 @@ This is a documentation for simple python module to work with the boticord api.
main main
modules modules
webhook webhook
event_reference reference
exceptions exceptions
Links Links

2
docs/events.rst → docs/reference.rst
View file

@ -1,6 +1,6 @@
.. currentmodule:: boticordpy .. currentmodule:: boticordpy
.. event_reference: .. reference:
Event Reference Event Reference
--------------- ---------------