doc: default model_mod documentation #958
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
This pull request updates the default_model_mod documentation. Previously the docs said the routines do no work, but some do! The default model mod routines and their outputs are described in "required model_mod routines" so this file has been updated. Removing the out-of-date template/readme.rst required updating filter.rst and closest_member_tools.rst to remove the now broken link.
Changes:
Updated “New Models” section in filter.rst to direct people to the “Porting new models guide.” This change removed the broken links in the paragraph.
Template model:
Updated “Required model_mod routines”
Default model mod documentation:
Fixes issue
Fixes #798
Partial fix for #957 (new model section)
Types of changes
Documentation changes needed?
Tests
Please describe any tests you ran to verify your changes.
Built the documentation locally.
make linkcheck
to find broken linksChecklist for merging
Checklist for release
Testing Datasets