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

Add documentation for resample_spec #7790

Closed
stscijgbot-jp opened this issue Aug 2, 2023 · 2 comments · Fixed by #8596
Closed

Add documentation for resample_spec #7790

stscijgbot-jp opened this issue Aug 2, 2023 · 2 comments · Fixed by #8596

Comments

@stscijgbot-jp
Copy link
Collaborator

Issue JP-3328 was created on JIRA by Melanie Clarke:

The ReadTheDocs pages for resampling contain minimal information about spectral resampling.

The ResampleSpecStep page, linked from the inheritance diagram on the main page, returns a 404 error. The resample_spec module also does not appear to be documented.

In particular, I was checking the external documentation for information about the output spectral WCS for NIRSpec data products, for work related to JP-3244.  I do not see the output transforms documented anywhere in the software documentation.

@stscijgbot-jp
Copy link
Collaborator Author

Comment by Melanie Clarke on JIRA:

Documentation updates for JP-3547 will fix the broken link for ResampleSpecStep and add the missing documentation for the ResampleSpecData class.

I have also added a note about the output frames available to the functions that produce the output WCS for NIRSpec and MIRI, and I have clarified which step parameters are used for spectral resampling and which are ignored.

Please let me know if there's anything else it would be useful to add.

@stscijgbot-jp
Copy link
Collaborator Author

Comment by Tyler Pauly on JIRA:

Fix included in #8596

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

Successfully merging a pull request may close this issue.

1 participant