10000 JP-3489: Update association expname docs by melanieclarke · Pull Request #8789 · spacetelescope/jwst · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

JP-3489: Update association expname docs #8 10000 789

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 7 commits into from
Sep 18, 2024
Merged

JP-3489: Update association expname docs #8789

merged 7 commits into from
Sep 18, 2024

Conversation

melanieclarke
Copy link
Collaborator
@melanieclarke melanieclarke commented Sep 16, 2024 •
edited
Loading

Resolves JP-3489

Updating documentation for paths in the association file keyword expname: relative or absolute path information is discouraged, but does not cause errors.

Also tidying up a couple related things:

  • Removing some extra spaces in the warning message about paths in expname
  • Resolving a long-standing warning about a missing stub file for jwst.associations.main: the item is now skipped.
  • Fixing a couple typos in docs for asn_from_list.

Tasks

  • request a review from someone specific, to avoid making the maintainers review every PR
  • add a build milestone, i.e. Build 11.3 (use the latest build if not sure)
  • Does this PR change user-facing code / API?
    • add an entry to CHANGES.rst within the relevant release section (otherwise add the no-changelog-entry-needed label to this PR)
    • 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

@melanieclarke melanieclarke requested a review from a team as a code owner September 16, 2024 17:16
@melanieclarke melanieclarke requested review from drlaw1558 and removed request for a team September 16, 2024 17:16
@melanieclarke melanieclarke added this to the Build 11.1 milestone Sep 16, 2024
@melanieclarke melanieclarke requested a review from a team September 16, 2024 17:44
@codecov Codecov
Copy link
codecov bot commented Sep 16, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.76%. Comparing base (120ee5a) to head (3d7f8f5).

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #8789   +/-   ##
=======================================
  Coverage   61.75%   61.76%           
=======================================
  Files         377      377           
  Lines       38749    38743    -6     
=======================================
- Hits        23931    23929    -2     
+ Misses      14818    14814    -4

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

drlaw1558
drlaw1558 approved these changes Sep 16, 2024
View reviewed changes
Copy link
Collaborator
@drlaw1558 drlaw1558 left a comment

Choose a reason for hiding this comment

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

LG2M, thanks for making the docs consistent!

tapastro
tapastro approved these changes Sep 18, 2024
View reviewed changes
Copy link
Contributor
@tapastro tapastro left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@melanieclarke melanieclarke merged commit 1a49457 into spacetelescope:master Sep 18, 2024
25 checks passed
@melanieclarke melanieclarke deleted the jp-3489 branch September 18, 2024 15:11
@stscijgbot-jp stscijgbot-jp mentioned this pull request Sep 19, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tapastro tapastro tapastro approved these changes

@drlaw1558 drlaw1558 drlaw1558 approved these changes

Assignees
No one assigned
Labels
associations documentation
Projects
None yet
Milestone
Build 11.1
Development

Successfully merging this pull request may close these issues.
3 participants
@melanieclarke @tapastro @drlaw1558
0