Skip to content

Commit efe6b98

Browse files
committed
add one more docstring
1 parent 87c8981 commit efe6b98

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

doc/_extensions/mitgcm.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,11 @@ def role(name, rawtext, text, lineno, inliner, options={}, content=[]):
6161
return role
6262

6363
def autolink(pattern):
64+
"""
65+
Return a role processor for external links based on a URL pattern.
66+
67+
%s in *pattern* will be replaced by the role text.
68+
"""
6469
def role(name, rawtext, text, lineno, inliner, options={}, content=[]):
6570
url = pattern % (text,)
6671
node = nodes.reference(rawtext, text, refuri=url, **options)

0 commit comments

Comments
 (0)