Skip to content

Commit f5d4ebd

Browse files
committed
Narrow the type of ChangeSet.descname to str
1 parent 3cfccf3 commit f5d4ebd

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

sphinx/directives/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ def run(self) -> list[Node]:
296296
'object-description-transform', self.domain, self.objtype, content_node
297297
)
298298
DocFieldTransformer(self).transform_all(content_node)
299-
self.env.temp_data['object'] = None
299+
self.env.temp_data['object'] = ''
300300
self.after_content()
301301

302302
if node['no-typesetting']:

sphinx/domains/changeset.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ class ChangeSet(NamedTuple):
4141
docname: str
4242
lineno: int
4343
module: str | None
44-
descname: str | None
44+
descname: str
4545
content: str
4646

4747

@@ -123,7 +123,7 @@ def changesets(self) -> dict[str, list[ChangeSet]]:
123123
def note_changeset(self, node: addnodes.versionmodified) -> None:
124124
version = node['version']
125125
module = self.env.ref_context.get('py:module')
126-
objname = self.env.temp_data.get('object')
126+
objname = self.env.temp_data.get('object', '')
127127
changeset = ChangeSet(node['type'], self.env.docname, node.line, # type: ignore[arg-type]
128128
module, objname, node.astext())
129129
self.changesets.setdefault(version, []).append(changeset)

0 commit comments

Comments
 (0)