You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/developer/documentation.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,4 +21,8 @@ For describing how to use more complicated inputs use a `note` admonition like:
21
21
## Outputs
22
22
All of the results functions should have a list of output fields with descriptions in a bulleted list in the function doc string.
23
23
When adding a new results function it should be added to the docs/reopt/outputs.md file so that it shows up in the online documentation.
24
-
There is no need to include the function signature in the doc string.
24
+
There is no need to include the function signature in the doc string.
25
+
26
+
27
+
## Testing Documentation
28
+
Test documentation changes locally to confirm they are working as intended. See docs/README.md for instructions. If Documenter cannot find your doc strings, ensure that there is no extra line between the doc string and the function.
0 commit comments