docs and formatting for fake_image.py, girsmconf.py, jwst_utils.py #246
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated docs and formatting for
fake_image.py
,girsmconf.py
,jwst_utils.py
.This is a continuation from PR's #229 and #240 as agreed with @gbrammer .
Specifically:
added missing / completed incomplete docstrings using AI tools.
went through formatting using black.
removed or edited some unused parameters
Very little done to
fake_image.py
.For
girsmconf.py
, in theCRDSGrismConf
class, I had issues with determining the interplay between the many DISP methods (DISPX
,INVDISPX
) and all alike, and the model evaluation methods that are being employed within (specially the inverse). I had made a best-attempt, and left some TODO comments on where I got stuck. Many of these methods are repetitive, so please feel free to let me know if/where the docs are incorrect (and if possible what corrections should be done) - I would happily to do another iteration and apply any feedback myself.In
jwst_utils.py
, some parameters were never used. These were mostly keyword args to other methods. I have exchanged hardcoded keyword args with the unused parameters where the intention for this was clear. All relevant parts are marked withTODO
comments for review.