diff options
| author |  Numerlor <[email protected]> | 2021-02-23 03:31:39 +0100 |
|---|---|---|
| committer | Numerlor <[email protected]> | 2021-02-23 03:33:29 +0100 |
| commit | d620a38bd03b7452474e12dc8a8531a868e7055d (patch) | |
| tree | 81793aa225fefb8c10cf12212476ca7f206ee297 | |
| parent | Remove redundant group check (diff) | |
Update docstrings
| -rw-r--r-- | bot/exts/info/doc/_cog.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/bot/exts/info/doc/_cog.py b/bot/exts/info/doc/_cog.py index 1e498237a..0b0611cbc 100644 --- a/bot/exts/info/doc/_cog.py +++ b/bot/exts/info/doc/_cog.py @@ -86,7 +86,7 @@ class DocCog(commands.Cog): * `package_name` is the package name to use, appears in the log * `base_url` is the root documentation URL for the specified package, used to build absolute paths that link to specific symbols - * `inventory_url` is the absolute URL to the intersphinx inventory. + * `package` are the InventoryDict contents of a intersphinx inventory. """ self.base_urls[api_package_name] = base_url @@ -225,7 +225,7 @@ class DocCog(commands.Cog): async def get_symbol_embed(self, symbol_name: str) -> Optional[discord.Embed]: """ - Attempt to scrape and fetch the data for the given `symbol`, and build an embed from its contents. + Attempt to scrape and fetch the data for the given `symbol_name`, and build an embed from its contents. If the symbol is known, an Embed with documentation about it is returned. |