aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Joe Banks <[email protected]>2025-11-10 18:51:58 +0000
committerGravatar Joe Banks <[email protected]>2025-11-10 18:51:58 +0000
commitc1a3673a91bc9653a492b1ca4060e8f588263bb0 (patch)
treed3298c76f0468a8ed3d060cc4284ee1fc24e6756
parentRemove colouredlogs from the project (diff)
Document class members in DocItem NamedTupleHEADmain
Co-authored-by: ChrisLovering <[email protected]>
-rw-r--r--bot/exts/info/doc/_doc_item.py19
1 files changed, 14 insertions, 5 deletions
diff --git a/bot/exts/info/doc/_doc_item.py b/bot/exts/info/doc/_doc_item.py
index a87b80efa..40d341fee 100644
--- a/bot/exts/info/doc/_doc_item.py
+++ b/bot/exts/info/doc/_doc_item.py
@@ -4,11 +4,20 @@ from typing import NamedTuple
class DocItem(NamedTuple):
"""Holds inventory symbol information."""
- 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
+ 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: