Merge pull request #152 from JuliaDocs/mp/template-docstring

Add clarification to at-template docstring
JuliaDocs · May 17, 2023 · a970c7d · a970c7d
2 parents 0a116d7 + 39c86a1
commit a970c7d
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/src/templates.jl b/src/templates.jl
@@ -22,7 +22,11 @@ hook!() = setter!(expander)
 $(:SIGNATURES)
 
 Defines a docstring template that will be applied to all docstrings in a module that match
-the specified category or tuple of categories.
+the specified category or tuple of categories of documented bindings.
+
+Effectively, it replaces all the matching docstrings in the module with the template.
+The `DOCSTRING` abbreviation can be used to splice the original docstring into the
+replacement docstring generated from the template.
 
 # Examples