The Alice and LORRI dictionary schema changes have been merged without the required documentation and regression tests. These need to be completed prior to releasing the dictionary, which in turn needs to happen when the data are published. The Pull Request Check List contains sections on both documentation updates and regression tests needed. Here they are, for convenience:
Documentation
[ ] Update the Change Log.
[x] Add all new classes and attributes to the namespace outline.
[ ] Document new classes and attributes added to nh:Mission_Parameters in the user documentation.
[x] Add examples of new classes and attributes.
In ChangeLog.md
[ ] List the major changes and additions made to the namespace individually.
[ ] Minor changes (like typos) may be grouped into a single mention.
[ ] Remove any changes that were previously documented but deleted from the branch before release.
In detailed/outline.rst
[x] Add new attributes and classes to the namespace outline following the existing style.
In index.rst:
[x] Add new examples to the table of contents.
In user/user-guide.rst:
[ ] Add new major subclasses to the content list for nh:Mission_Parameters in the correct order and link it to the following subclass heading.
[ ] Add a new section for each new major subclass in the correct order following the model of the existing classes (e.g., nh:Observational_Parameters).
[ ] Add new subsections for all new attributes added to the nh:Mission_Parameters class or any of its major subclasses.
In examples/
[x] Add a new label if there is no existing example for a new instrument. Follow the model of the existing Mockup.rst files.
OR
[x] Modify an existing label to show the use of a new class that is specific to an instrument.
[x] Supply a partial label to show the use of a new class that would not easily fit into the existing label(s) for the relevant instrument.
Regression Tests
[x] Add new regression tests or update existing regression tests to illustrate correct use of new classes (the label used for the example can be re-used here).
[ ] Add regression tests for critical items enforced by schema constraint (both VALID and FAIL).
[ ] Add regression tests to demonstrate bug resolution with a reference to the specific issue raised (this may require only one of either VALID or FAIL tests in some cases).
[ ] Document new regression tests in test/README.md following the pattern for existing tests. Bug fixes should reference the issue number.
The Alice and LORRI dictionary schema changes have been merged without the required documentation and regression tests. These need to be completed prior to releasing the dictionary, which in turn needs to happen when the data are published. The Pull Request Check List contains sections on both documentation updates and regression tests needed. Here they are, for convenience:
Documentation
In ChangeLog.md
In detailed/outline.rst
In index.rst:
In user/user-guide.rst:
In examples/
Regression Tests