-
Notifications
You must be signed in to change notification settings - Fork 22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Clarify docs headers #446
Clarify docs headers #446
Conversation
@PaulHuwe I don't appear to have permissions to request reviewers. Would you take a look? Also @ketozhang how does the updated wording look to you? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with one suggestion
7bc08c1
to
7ce376e
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #446 +/- ##
==========================================
+ Coverage 95.38% 95.45% +0.06%
==========================================
Files 4 4
Lines 195 198 +3
==========================================
+ Hits 186 189 +3
Misses 9 9 ☔ View full report in Codecov by Sentry. |
Looks better, thank you @braingram Couple of 'file schema' left in the sidebar. If these are truly schemas for the entire file, then this makes sense. |
Thanks for taking a look. #447 addresses the TOC As the I updated the The issue will remain searchable after it's closed which can also be helpful if someone else runs into this confusion. |
f6c4abc
to
87da3f2
Compare
Updates schema docs to:
Link to updated docs: https://rad--446.org.readthedocs.build/en/446/schemas.html
Only a docs change so no downstream tests will be run.
Closes #427
Tasks
rad
tests.docs/
page.no-changelog-entry-needed
.)changes/
:echo "changed something" > changes/<PR#>.<changetype>.rst
(see below for change types).romancal
regression test (https://github.com/spacetelescope/RegressionTests/actions/workflows/romancal.yml) with this branch installed ("git+https://github.com/<fork>/rad@<branch>"
).roman_datamodels
utilities 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