We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
2 parents 0a116d7 + 39c86a1 commit a970c7dCopy full SHA for a970c7d
src/templates.jl
@@ -22,7 +22,11 @@ hook!() = setter!(expander)
22
$(:SIGNATURES)
23
24
Defines a docstring template that will be applied to all docstrings in a module that match
25
-the specified category or tuple of categories.
+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.
30
31
# Examples
32
0 commit comments