documentation special instruction

spine-tools · Oct 2, 2023 · 078d6e6 · 078d6e6
1 parent cd7f74c
commit 078d6e6
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/src/implementation_details/documentation.md b/docs/src/implementation_details/documentation.md
@@ -25,6 +25,8 @@ The current list of fields for constraints:
 + description: describes the formulation of the constraint in words
 + formulation: describes the formulation of the constraints in latex formulas
 
+There is also a special instruction specifically for getting the same field (or fields) from all constraint functions; instead of specifying the function name you can write `alldocstrings`. It will also automatically generate titles in between corresponding to the constraint.
+
 An example for how the docstring looks:
 
 ```