Skip to content

Commit 47983b5

Browse files
authored
chore: add type hints and docstrings (#433)
* chore: add type hints and docstrings * chore: fix minor adjustments * test: revert unintended changes
1 parent e5e33ad commit 47983b5

File tree

12 files changed

+690
-317
lines changed

12 files changed

+690
-317
lines changed

packages/gcp-sphinx-docfx-yaml/docfx_yaml/directives.py

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,21 +26,17 @@
2626

2727

2828
class RemarksDirective(BaseAdmonition):
29-
"""
30-
Class to enable remarks directive.
31-
"""
29+
"""A directive to handle 'remarks' blocks."""
3230
node_class = remarks
3331

3432
class TodoDirective(Directive):
35-
"""
36-
Class to ignore todo directive.
37-
"""
33+
"""A directive to ignore 'todo' blocks."""
3834

3935
# Enable content in the directive
4036
has_content = True
4137

42-
# Directive class must override run function.
43-
def run(self):
38+
def run(self) -> list[nodes.Node]:
39+
"""This directive is ignored, so return empty list."""
4440
return_nodes = []
4541

4642
return return_nodes

0 commit comments

Comments
 (0)