Skip to content

Commit c350dcd

Browse files
committed
add note to test docs
1 parent 2fa97d6 commit c350dcd

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

docs/src/developer/documentation.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,8 @@ For describing how to use more complicated inputs use a `note` admonition like:
2121
## Outputs
2222
All of the results functions should have a list of output fields with descriptions in a bulleted list in the function doc string.
2323
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

Comments
 (0)