Skip to content

Commit a970c7d

Browse files
Merge pull request #152 from JuliaDocs/mp/template-docstring
Add clarification to at-template docstring
2 parents 0a116d7 + 39c86a1 commit a970c7d

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

Diff for: src/templates.jl

+5-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,11 @@ hook!() = setter!(expander)
2222
$(:SIGNATURES)
2323
2424
Defines a docstring template that will be applied to all docstrings in a module that match
25-
the specified category or tuple of categories.
25+
the specified category or tuple of categories of documented bindings.
26+
27+
Effectively, it replaces all the matching docstrings in the module with the template.
28+
The `DOCSTRING` abbreviation can be used to splice the original docstring into the
29+
replacement docstring generated from the template.
2630
2731
# Examples
2832

0 commit comments

Comments
 (0)