expand reference file schema docs #375
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
braingram
force-pushed
the
ref_schema_docs
branch
from
11b9a79 to
5ba0d1f
Compare
emolter
reviewed
Jan 9, 2025
Co-authored-by: Ned Molter <[email protected]>
Co-authored-by: Ned Molter <[email protected]>
Co-authored-by: Ned Molter <[email protected]>
Co-authored-by: Ned Molter <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #375 +/- ##
===========================================
+ Coverage 67.59% 78.20% +10.60%
===========================================
Files 115 115
Lines 5932 5135 -797
===========================================
+ Hits 4010 4016 +6
+ Misses 1922 1119 -803 ☔ View full report in Codecov by Sentry. |
|
Thanks for the improvements. I like the new wording. I accepted most of your suggestions with one follow-up comment about the section header. |
emolter
approved these changes
Jan 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Link to updated docs:
https://stdatamodels--375.org.readthedocs.build/en/375/jwst/datamodels/schemas.html#reference-file-keywords
Expand documentation for reference file schemas to mention
keyword_*references and "pattern"keyword_p*references.Tasks
docs/pageno-changelog-entry-needed)changes/:echo "changed something" > changes/<PR#>.<changetype>.rst(see below for change types)jwstregression tests with this branch installed ("git+https://github.com/<fork>/stdatamodels@<branch>")news fragment change types...
changes/<PR#>.feature.rst: new featurechanges/<PR#>.bugfix.rst: fixes an issuechanges/<PR#>.doc.rst: documentation changechanges/<PR#>.removal.rst: deprecation or removal of public APIchanges/<PR#>.misc.rst: infrastructure or miscellaneous change