Skip to content

Commit c1a3673

Browse files
jb3ChrisLovering
andcommitted
Document class members in DocItem NamedTuple
Co-authored-by: ChrisLovering <ChrisLovering@users.noreply.github.com>
1 parent acad2ea commit c1a3673

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

bot/exts/info/doc/_doc_item.py

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,20 @@
44
class DocItem(NamedTuple):
55
"""Holds inventory symbol information."""
66

7-
package: str # Name of the package name the symbol is from
8-
group: str # Interpshinx "role" of the symbol, for example `label` or `method`
9-
base_url: str # Absolute path to to which the relative path resolves, same for all items with the same package
10-
relative_url_path: str # Relative path to the page where the symbol is located
11-
symbol_id: str # Fragment id used to locate the symbol on the page
7+
package: str
8+
"""Name of the package name the symbol is from"""
9+
10+
group: str
11+
"""Interpshinx "role" of the symbol, for example `label` or `method`"""
12+
13+
base_url: str
14+
"""Absolute path to to which the relative path resolves, same for all items with the same package"""
15+
16+
relative_url_path: str
17+
"""Relative path to the page where the symbol is located"""
18+
19+
symbol_id: str
20+
"""Fragment id used to locate the symbol on the page"""
1221

1322
@property
1423
def url(self) -> str:

0 commit comments

Comments
 (0)