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.

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

RCAL-318: Update the reference file document for reftype "distortion" #493

Merged
merged 4 commits into from
May 10, 2022
Merged

RCAL-318: Update the reference file document for reftype "distortion" #493

merged 4 commits into from
May 10, 2022

Conversation

PaulHuwe
Copy link
Collaborator

GitHub issue, Closes #461

Resolves RCAL-318

Description

This PR addresses adding documentation for Distortion reference files.

Checklist

  • Tests

  • Documentation

  • Change log

  • Milestone

  • Label(s)

@codecov
Copy link

codecov bot commented May 10, 2022 •
edited
Loading

Codecov Report

Merging #493 (d2216c3) into main (13fad14) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #493   +/-   ##
=======================================
  Coverage   78.29%   78.29%           
=======================================
  Files          39       39           
  Lines        1023     1023           
=======================================
  Hits          801      801           
  Misses        222      222
Flag Coverage Δ *Carryforward flag
nightly 78.29% <ø> (ø) Carriedforward from 057717d

*This pull request uses carry forward flags. Click here to find out more.

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 13fad14...d2216c3. Read the comment docs.

@stscijgbot-rstdms stscijgbot-rstdms mentioned this pull request May 10, 2022
Closed
ddavis-stsci
ddavis-stsci approved these changes May 10, 2022
View reviewed changes
Copy link
Collaborator

@ddavis-stsci ddavis-stsci left a comment

Choose a reason for hiding this comment

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

A few minor wording nits otherwise it looks good.

docs/roman/references_general/distortion_selection.inc Outdated

Reference Selection Keyword Attributes for DISTORTION
+++++++++++++++++++++++++++++++++++++++++++++++++++++
CRDS selects appropriate DISTORTION references based on the following keyword attributes.
Copy link
Collaborator

Choose a reason for hiding this comment

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

DISTORTION references based
to
DISTORTION reference files based
Q: can there be multiple distortion reference files?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Changed.
Has it been decided, I didn't see much in terms of documentation on it. @nden ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

All these changes now added (modulo Nadia's requests).

Copy link
Collaborator

Choose a reason for hiding this comment

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

It's one file per type. CRDS needs to identify and return only one file. If more corrections are needed they will be in a different reftype, e.g. for filter offsets.

@PaulHuwe PaulHuwe merged commit eca816e into spacetelescope:main May 10, 2022
@PaulHuwe PaulHuwe deleted the RCAL-318_DistortionDocs branch May 10, 2022 18:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nden nden nden approved these changes

@cshanahan1 cshanahan1 cshanahan1 approved these changes

@ddavis-stsci ddavis-stsci ddavis-stsci approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update the reference file document for reftype "distortion"
4 participants
@PaulHuwe @nden @cshanahan1 @ddavis-stsci