diff options
| author |  Numerlor <[email protected]> | 2021-03-05 01:47:58 +0100 |
|---|---|---|
| committer | Numerlor <[email protected]> | 2021-03-05 02:46:41 +0100 |
| commit | 33d6df2eae9d235db3405966e3f55db970582632 (patch) | |
| tree | f5b1dea5c18b40f81e3e7e34b36157c2560dbe4c | |
| parent | Use placeholder consistent with others in the cog (diff) | |
Explain use of various containers in the cog
Co-authored-by: MarkKoz <[email protected]>
| -rw-r--r-- | bot/exts/info/doc/_cog.py | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/bot/exts/info/doc/_cog.py b/bot/exts/info/doc/_cog.py index fd8ed2008..cedd31f55 100644 --- a/bot/exts/info/doc/_cog.py +++ b/bot/exts/info/doc/_cog.py @@ -58,10 +58,13 @@ class DocCog(commands.Cog): """A set of commands for querying & displaying documentation.""" def __init__(self, bot: Bot): + # Contains URLs to documentation home pages. + # Used to calculate inventory diffs on refreshes and to display all currently stored inventories. self.base_urls = {} self.bot = bot - self.doc_symbols: Dict[str, DocItem] = {} + self.doc_symbols: Dict[str, DocItem] = {} # Maps symbol names to objects containing their metadata. self.item_fetcher = _batch_parser.BatchParser() + # Maps a conflicting symbol name to a list of the new, disambiguated names created from conflicts with the name. self.renamed_symbols = defaultdict(list) self.inventory_scheduler = Scheduler(self.__class__.__name__) |