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: Auto-inject CLI help into user doc #3286

Merged
merged 1 commit into from
Nov 13, 2024

Conversation

pllim
Copy link
Contributor

@pllim pllim commented Nov 12, 2024

Description

This pull request is to address Cami's desire to see jdaviz --help printed in user doc.

Rendered doc: https://jdaviz--3286.org.readthedocs.build/en/3286/quickstart.html#as-a-standalone-application

Change log entry

  • Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts,
    list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer
    should add a no-changelog-entry-needed label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

  • Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
  • Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
  • Do the proposed changes follow the STScI Style Guides?
  • Are tests added/updated as required? If so, do they follow the STScI Style Guides?
  • Are docs added/updated as required? If so, do they follow the STScI Style Guides?
  • Did the CI pass? If not, are the failures related?
  • Is a milestone set? Set this to bugfix milestone if this is a bug fix and needs to be released ASAP; otherwise, set this to the next major release milestone. Bugfix milestone also needs an accompanying backport label.
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)? 🐱

@pllim pllim added documentation Explanation of code and concepts trivial Only needs one approval instead of two no-changelog-entry-needed changelog bot directive labels Nov 12, 2024
@pllim pllim added this to the 4.1 milestone Nov 12, 2024
@pllim pllim marked this pull request as ready for review November 12, 2024 22:56
Copy link

codecov bot commented Nov 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.76%. Comparing base (3b00695) to head (ee37b80).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3286   +/-   ##
=======================================
  Coverage   88.76%   88.76%           
=======================================
  Files         125      125           
  Lines       18961    18961           
=======================================
  Hits        16830    16830           
  Misses       2131     2131           

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

Copy link
Member

@kecnry kecnry left a comment

Choose a reason for hiding this comment

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

Cool!

@camipacifici camipacifici self-requested a review November 13, 2024 16:06
Copy link
Contributor

@camipacifici camipacifici left a comment

Choose a reason for hiding this comment

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

Perfect, thank you!

@pllim pllim merged commit 4a43a8c into spacetelescope:main Nov 13, 2024
19 checks passed
@pllim pllim deleted the doc-inject-cli branch November 13, 2024 16:51
@pllim
Copy link
Contributor Author

pllim commented Nov 13, 2024

Thanks for the reviews!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Explanation of code and concepts no-changelog-entry-needed changelog bot directive trivial Only needs one approval instead of two
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants