Skip to content

DOC: Complete API for persistence#10524

Open
pllim wants to merge 1 commit into
spacetelescope:mainfrom
pllim:von-traps
Open

DOC: Complete API for persistence#10524
pllim wants to merge 1 commit into
spacetelescope:mainfrom
pllim:von-traps

Conversation

@pllim
Copy link
Copy Markdown
Collaborator

@pllim pllim commented May 7, 2026

Towards JP-4107

This PR addresses persistence portion of #9793 . Only touch docs so should not need RT.

On main:

With this patch:

Tasks

  • If you have a specific reviewer in mind, tag them.
  • add a build milestone, i.e. Build 12.0 (use the latest build if not sure)
  • Does this PR change user-facing code / API? (if not, label with no-changelog-entry-needed)
    • write news fragment(s) in changes/: echo "changed something" > changes/<PR#>.<changetype>.rst (see changelog readme for instructions)
      • if your change breaks step-level or public API (as defined in the docs), also add a changes/<PR#>.breaking.rst news fragment
    • update or add relevant tests
    • update relevant docstrings and / or docs/ page
    • start a regression test and include a link to the running job (click here for instructions)
      • Do truth files need to be updated ("okified")?
        • after the reviewer has approved these changes, run okify_regtests to update the truth files
  • if a JIRA ticket exists, make sure it is resolved properly

@pllim pllim added this to the Build 13.0 milestone May 7, 2026
@pllim pllim marked this pull request as ready for review May 7, 2026 19:23
@pllim pllim requested a review from a team May 7, 2026 19:23
@codecov
Copy link
Copy Markdown

codecov Bot commented May 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.38%. Comparing base (e5f2495) to head (f562ee7).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #10524      +/-   ##
==========================================
- Coverage   86.38%   86.38%   -0.01%     
==========================================
  Files         373      373              
  Lines       40068    40067       -1     
==========================================
- Hits        34612    34611       -1     
  Misses       5456     5456              

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

@melanieclarke
Copy link
Copy Markdown
Collaborator

@kmacdonald-stsci - I know you're working on the persistence docs for #10091. Do you want to get these in first and rebase your branch or hold off on this one?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants