Skip to content
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

Merged
merged 7 commits into from
Sep 26, 2024
Merged

Conversation

braingram
Copy link
Collaborator

@braingram braingram commented Sep 20, 2024

Updates schema docs to:

  • remove mention of "File schemas"
  • add a one sentence description
  • add links to asdf schema docs and roman_datamodels docs

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

  • Update or add relevant rad tests.
  • Update relevant docstrings and / or docs/ page.
  • Does this PR change any schema files?
    • Schema changes were discussed at RAD Review Board meeting.
  • Does this PR change any API used downstream? (If not, label with no-changelog-entry-needed.)
News fragment change types:
  • changes/<PR#>.feature.rst: new feature
  • changes/<PR#>.bugfix.rst: fixes an issue
  • changes/<PR#>.doc.rst: documentation change
  • changes/<PR#>.removal.rst: deprecation or removal of public API
  • changes/<PR#>.misc.rst: infrastructure or miscellaneous change

@braingram braingram marked this pull request as ready for review September 20, 2024 17:39
@braingram braingram requested a review from a team as a code owner September 20, 2024 17:39
@braingram
Copy link
Collaborator Author

@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?

docs/schemas.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@PaulHuwe PaulHuwe left a 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

Copy link

codecov bot commented Sep 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.45%. Comparing base (c1811ab) to head (f6c4abc).
Report is 22 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

@ketozhang
Copy link

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.
image

Looks like something is wrong with the TOC
image

@braingram
Copy link
Collaborator Author

Thanks for taking a look.

#447 addresses the TOC

As the Reference File Schemas are schemas used in reference files I think we have to live with that title. I made a slight change to the page to try and remove some of the ambiguity.

I updated the Ground Tests File Schemas to Ground Tests Schemas.

The issue will remain searchable after it's closed which can also be helpful if someone else runs into this confusion.

@braingram braingram merged commit b9df6e9 into spacetelescope:main Sep 26, 2024
11 checks passed
@braingram braingram deleted the clarify_docs_headers branch September 26, 2024 19:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Clarification that file schema means top-level field's tag schemas
3 participants