Skip to content

Commit 94fa543

Browse files
committed
additional final edits of docstrings
1 parent e3686be commit 94fa543

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

sphinx_exercise/post_transforms.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@
1919

2020

2121
def build_reference_node(app, target_node):
22+
"""
23+
Builds a docutil.nodes.reference object
24+
to a given target_node.
25+
"""
2226
refuri = app.builder.get_relative_uri(
2327
app.env.docname, target_node.get("docname", "")
2428
)
@@ -35,8 +39,9 @@ def build_reference_node(app, target_node):
3539

3640
class UpdateReferencesToEnumerated(SphinxPostTransform):
3741
"""
38-
Check :ref: made to enumerated target nodes and update to :numref:
39-
"""
42+
Updates all :ref: to :numref: if used when referencing
43+
an enumerated exercise node.
44+
]"""
4045

4146
default_priority = 5
4247

0 commit comments

Comments
 (0)