Skip to content

RAD-229: Clean up the documentation after all the RAD updates.#745

Merged
PaulHuwe merged 27 commits into
spacetelescope:mainfrom
WilliamJamieson:doc_cleanup
Oct 16, 2025
Merged

RAD-229: Clean up the documentation after all the RAD updates.#745
PaulHuwe merged 27 commits into
spacetelescope:mainfrom
WilliamJamieson:doc_cleanup

Conversation

@WilliamJamieson

Copy link
Copy Markdown
Collaborator

Resolves RAD-229

Closes #713
Closes #683

This PR makes updates to the docs.

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

@WilliamJamieson WilliamJamieson requested a review from a team as a code owner October 15, 2025 21:40
@codecov

codecov Bot commented Oct 15, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.89%. Comparing base (58eb8dd) to head (42ec6b2).
⚠️ Report is 119 commits behind head on main.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread changes/745.doc.rst Outdated
Comment thread docs/creating.rst Outdated
Comment thread docs/creating.rst Outdated
Comment thread docs/creating.rst Outdated
Comment thread docs/creating.rst Outdated
Comment thread docs/creating.rst Outdated
Comment thread docs/creating.rst Outdated
Comment thread docs/creating.rst Outdated
Comment thread docs/ssc.rst Outdated
Comment thread docs/ssc.rst Outdated

@schlafly schlafly left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 thread docs/creating.rst Outdated
Comment thread docs/creating.rst Outdated
Comment thread docs/creating.rst Outdated
Comment thread docs/creating.rst Outdated
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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@PaulHuwe PaulHuwe merged commit 7f58522 into spacetelescope:main Oct 16, 2025
16 checks passed
@WilliamJamieson WilliamJamieson deleted the doc_cleanup branch October 16, 2025 13:49
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.

Clean up documentation from RAD updates Mention the SSC schemas in the Docs

3 participants