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

Updated and corrected the wf3cte.rst and wf3cte.py files #69

Merged
merged 4 commits into from
Apr 24, 2023

Conversation

mdlpstsci
Copy link
Contributor

Significant updates to the wf3cte.rst file.

Modified the wf3cte.py file as follows:

  • Removed background documentation on the CTE algorithm which does not belong in this source file. Replaced with URLs for handy reference, particularly so the documentation is not duplicated in multiple locations, and the latest information is available for viewing.
  • Removed support for incorrect items from the source: ability to set the output filename and ability for the code to accept an association table as input.

Removal of the output filename modifies the API.

@mdlpstsci mdlpstsci added bug maintainance General Package Mantainance documentation labels Sep 23, 2022
@mdlpstsci mdlpstsci self-assigned this Sep 23, 2022
@mdlpstsci mdlpstsci changed the title Updated and corrected the wf3cte.rst and wf3cte.py files Do Not Merge until HSTCAL > v2.7.4 is released: Updated and corrected the wf3cte.rst and wf3cte.py files Oct 12, 2022
docs/wfc3tools/wf3cte.rst Show resolved Hide resolved
wfc3tools/wf3cte.py Show resolved Hide resolved
wfc3tools/wf3cte.py Show resolved Hide resolved
docs/wfc3tools/wf3cte.rst Outdated Show resolved Hide resolved
docs/wfc3tools/wf3cte.rst Outdated Show resolved Hide resolved
Copy link

@FDauphin FDauphin left a comment

Choose a reason for hiding this comment

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

Nice edits. Comments mostly include grammar and hyperlinks.

docs/wfc3tools/wf3cte.rst Outdated Show resolved Hide resolved
docs/wfc3tools/wf3cte.rst Outdated Show resolved Hide resolved
docs/wfc3tools/wf3cte.rst Outdated Show resolved Hide resolved
docs/wfc3tools/wf3cte.rst Outdated Show resolved Hide resolved
docs/wfc3tools/wf3cte.rst Outdated Show resolved Hide resolved
docs/wfc3tools/wf3cte.rst Outdated Show resolved Hide resolved
docs/wfc3tools/wf3cte.rst Outdated Show resolved Hide resolved
docs/wfc3tools/wf3cte.rst Outdated Show resolved Hide resolved
wfc3tools/wf3cte.py Show resolved Hide resolved
wfc3tools/wf3cte.py Show resolved Hide resolved
Removed background documentation on the CTE algorithm which does not
belong in this source file.  Replaced with URLs for handy reference,
particularly so the documentation is not duplicated in multiple
locations, and the latest information is available for viewing.
Removed support for incorrect items from the source: ability to
set the output filename and ability for the code to accept an
association table as input.  Removal of the output filename modifies
the API.
to the documentatio to clarify understanding and correct typos.
Question with regard to removal of parameters from the Python
interface where addressed.  The parameters were effectively no-ops.
Copy link

@FDauphin FDauphin left a comment

Choose a reason for hiding this comment

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

All comments in review were addressed. Just one hyperlink issue and checking on a previous comment.

docs/wfc3tools/wf3cte.rst Outdated Show resolved Hide resolved
wfc3tools/wf3cte.py Show resolved Hide resolved
@mdlpstsci mdlpstsci changed the title Do Not Merge until HSTCAL > v2.7.4 is released: Updated and corrected the wf3cte.rst and wf3cte.py files Updated and corrected the wf3cte.rst and wf3cte.py files Apr 17, 2023
@mdlpstsci
Copy link
Contributor Author

@cshanahan1 @FDauphin I am starting to prep for a new build release candidate which can include as many WFC3 changes that can fit. This PR needs a re-review. Thanks.

Copy link

@FDauphin FDauphin left a comment

Choose a reason for hiding this comment

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

All of my comments have been addressed. Approving for merge; thanks again 👍🏾

@mdlpstsci mdlpstsci merged commit e370a2b into spacetelescope:master Apr 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug documentation maintainance General Package Mantainance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants