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

DOC: Add ref to main title so downstream can use intersphinx #1529

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

pllim
Copy link
Contributor

@pllim pllim commented Nov 19, 2024

I cannot add milestone or label here, but you can milestone to whatever you want but preferably whatever version you plan to release next (be it major, minor, or bug fix) and backport if needed. No change log is needed.

This is to address https://github.com/spacetelescope/jdaviz/pull/3301/files#r1847057593

Tasks

  • request a review from someone specific, to avoid making the maintainers review every PR @bmorris3
  • add a build milestone, i.e. 24Q4_B15 (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 below for change types)
    • 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

so downstream can use intersphinx
@pllim pllim requested a review from a team as a code owner November 19, 2024 15:26
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 19, 2024
@pllim
Copy link
Contributor Author

pllim commented Nov 19, 2024

Also no actual code is touched so you can skip all the CI stuff in your checklist. Just make sure RTD builds. Thanks.

Copy link

codecov bot commented Nov 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.68%. Comparing base (caef567) to head (c30157b).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1529   +/-   ##
=======================================
  Coverage   76.68%   76.68%           
=======================================
  Files         120      120           
  Lines        7832     7832           
=======================================
  Hits         6006     6006           
  Misses       1826     1826           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation no-changelog-entry-needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants