RAD-229: Clean up the documentation after all the RAD updates.#745
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #745 +/- ##
==========================================
- Coverage 97.76% 88.89% -8.87%
==========================================
Files 8 14 +6
Lines 759 1018 +259
==========================================
+ Hits 742 905 +163
- Misses 17 113 +96 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
PaulHuwe
reviewed
Oct 16, 2025
schlafly
approved these changes
Oct 16, 2025
schlafly
left a comment
Collaborator
There was a problem hiding this comment.
This looks great, thanks William. I have a few minor grammar / wording changes. I also reworded the paragraph about "don't introduce new internal tags"; if I screwed it up in my suggested rewording, please discard!
Comment on lines
+458
to
+460
| In most cases you will not tag a schema. These are generally, when the schema | ||
| is not intended to be used as a datamodel. This allows for easy reuse of schemas | ||
| and extending another schema, see :ref:`pseudo-inheritance` for more information. |
Collaborator
There was a problem hiding this comment.
Suggested change
| In most cases you will not tag a schema. These are generally, when the schema | |
| is not intended to be used as a datamodel. This allows for easy reuse of schemas | |
| and extending another schema, see :ref:`pseudo-inheritance` for more information. | |
| Internal schemas that describe only part of a datamodel should not be tagged. These | |
| internal schemas are generally used when multiple datamodels or parts of the metadata | |
| want to reuse or extend the same information. See :ref:`pseudo-inheritance` for more information. |
Co-authored-by: Eddie Schlafly <eschlafly@gmail.com>
Co-authored-by: Eddie Schlafly <eschlafly@gmail.com>
Co-authored-by: Eddie Schlafly <eschlafly@gmail.com>
PaulHuwe
approved these changes
Oct 16, 2025
This file contains hidden or 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
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.
Resolves RAD-229
Closes #713
Closes #683
This PR makes updates to the docs.
Tasks
radtests.docs/page.no-changelog-entry-needed.)changes/:echo "changed something" > changes/<PR#>.<changetype>.rst(see below for change types).romancalregression test (https://github.com/spacetelescope/RegressionTests/actions/workflows/romancal.yml) with this branch installed ("git+https://github.com/<fork>/rad@<branch>").roman_datamodelsutilities and tests.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