diff options
author | 2021-03-05 01:48:29 +0100 | |
---|---|---|
committer | 2021-03-05 02:46:41 +0100 | |
commit | e811070c0909f596e1767ee955b302b5f60a16d8 (patch) | |
tree | 132ccd60d77495487e37e8c3e64d7b0b373842da | |
parent | Explain use of various containers in the cog (diff) |
Rename params to clearer and more concise alternatives
-rw-r--r-- | bot/exts/info/doc/_cog.py | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/bot/exts/info/doc/_cog.py b/bot/exts/info/doc/_cog.py index cedd31f55..8dcc1eff3 100644 --- a/bot/exts/info/doc/_cog.py +++ b/bot/exts/info/doc/_cog.py @@ -81,7 +81,7 @@ class DocCog(commands.Cog): await self.bot.wait_until_guild_available() await self.refresh_inventories() - def update_single(self, api_package_name: str, base_url: str, package: InventoryDict) -> None: + def update_single(self, package_name: str, base_url: str, inventory: InventoryDict) -> None: """ Build the inventory for a single package. @@ -91,16 +91,16 @@ class DocCog(commands.Cog): absolute paths that link to specific symbols * `package` is the content of a intersphinx inventory. """ - self.base_urls[api_package_name] = base_url + self.base_urls[package_name] = base_url - for group, items in package.items(): + for group, items in inventory.items(): for symbol_name, relative_doc_url in items: # e.g. get 'class' from 'py:class' group_name = group.split(":")[1] if (original_item := self.doc_symbols.get(symbol_name)) is not None: replaced_symbol_name = self.ensure_unique_symbol_name( - api_package_name, + package_name, group_name, original_item, symbol_name, @@ -111,7 +111,7 @@ class DocCog(commands.Cog): relative_url_path, _, symbol_id = relative_doc_url.partition("#") # Intern fields that have shared content so we're not storing unique strings for every object doc_item = DocItem( - api_package_name, + package_name, sys.intern(group_name), base_url, sys.intern(relative_url_path), @@ -120,7 +120,7 @@ class DocCog(commands.Cog): self.doc_symbols[symbol_name] = doc_item self.item_fetcher.add_item(doc_item) - log.trace(f"Fetched inventory for {api_package_name}.") + log.trace(f"Fetched inventory for {package_name}.") async def update_or_reschedule_inventory( self, |