diff options
| author |  Numerlor <[email protected]> | 2021-03-05 01:19:16 +0100 |
|---|---|---|
| committer | Numerlor <[email protected]> | 2021-03-05 02:46:40 +0100 |
| commit | 0b8dab1840ba4f14b41f18a88d0fd870dfeec7fe (patch) | |
| tree | 60e6292668957b271472361c3d9683cd08e42c4c | |
| parent | Do _item_futures cleanup in _parse_queue instead of a concurrent task (diff) | |
Add comments for purpose of DocItem attributes
| -rw-r--r-- | bot/exts/info/doc/_cog.py | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/bot/exts/info/doc/_cog.py b/bot/exts/info/doc/_cog.py index 80f85d625..fd8ed2008 100644 --- a/bot/exts/info/doc/_cog.py +++ b/bot/exts/info/doc/_cog.py @@ -42,11 +42,11 @@ COMMAND_LOCK_SINGLETON = "inventory refresh" class DocItem(NamedTuple): """Holds inventory symbol information.""" - package: str - group: str - base_url: str - relative_url_path: str - symbol_id: str + package: str # Name of the package name the symbol is from + group: str # Interpshinx "role" of the symbol, for example `label` or `method` + base_url: str # Absolute path to to which the relative path resolves, same for all items with the same package + relative_url_path: str # Relative path to the page where the symbol is located + symbol_id: str # Fragment id used to locate the symbol on the page @property def url(self) -> str: |