Documentation#
All projects have their own scientific and technical documentation. Most notably:
UM Documentation Papers |
||
JULES User Guide |
||
LFRic Documentation Papers |
LFRic Apps and Core also use doxygen to document the code and all changes should include appropriate doxygen changes to go with them. Doxygen guidelines are available on the LFRic Technical pages.
Small changes and bug fixes rarely need documentation to be updated, but when new science is added to a project, the documentation must be updated to ensure that it remains contemporary with the code.
Tip
Searching the relevant documentation for words related to your change is often useful when deciding whether to update the documentation.
Documentation changes that are held within a repository are formally reviewed, and should be included on the same ticket as the code changes - making sure both code and docs branches are clearly listed and the doc keyword is applied.