Addition of missing/incomplete docs #65
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
resample_numba.py, slit_combine.py, spectrum.py
address TODO
reviewed changes
reviewed changes
gbrammer
reviewed
May 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes made to drizzle.py, slit_combine.py, resample_numba.py and slit_combine.py
This concludes the overall documentation walk-through together with PR's #61 and #59 (since resample.py did not need any edits).
The commentary is the same as in #61 and #59 - in short: both missing docstrings were generated, as well as any docstrings missing parameters/returns were completed, using AI where sensible. A hand-full of unsused parameters were deleted. Some automatic formatting changes from 'black' made their way into the commit - I will let them stay.
All ambiguities have been commented with "TODO" statements one line above the docstring.
Formatting has been re-checked with 'black' and 'flake8'. URL's were allowed to exceed 79 characters.
All 17 pytests pass - 7 warnings.