From 078d6e6a777291c76946f9f9598ced7bde06b411 Mon Sep 17 00:00:00 2001 From: Tars Verschelde Date: Mon, 2 Oct 2023 10:34:47 +0200 Subject: [PATCH] documentation special instruction --- docs/src/implementation_details/documentation.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/src/implementation_details/documentation.md b/docs/src/implementation_details/documentation.md index 8d119ac100..48f2cd929f 100644 --- 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: ```