From 0b83f7a2caa29f9a51cf4f913ce0d1866812f077 Mon Sep 17 00:00:00 2001 From: Victor Kotlin Date: Sun, 12 Sep 2021 13:18:22 +0300 Subject: [PATCH] update docs --- boticordpy/webhook.py | 6 +++++- docs/index.rst | 2 +- docs/{events.rst => reference.rst} | 2 +- 3 files changed, 7 insertions(+), 3 deletions(-) rename docs/{events.rst => reference.rst} (98%) diff --git a/boticordpy/webhook.py b/boticordpy/webhook.py index cdc7b8e..b5b4eef 100644 --- a/boticordpy/webhook.py +++ b/boticordpy/webhook.py @@ -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 diff --git a/docs/index.rst b/docs/index.rst index da36937..db5435c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 diff --git a/docs/events.rst b/docs/reference.rst similarity index 98% rename from docs/events.rst rename to docs/reference.rst index 43d3c99..1af6ffc 100644 --- a/docs/events.rst +++ b/docs/reference.rst @@ -1,6 +1,6 @@ .. currentmodule:: boticordpy -.. event_reference: +.. reference: Event Reference ---------------