Docs and formatting of multifit.py and prep.py #252
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
KostasValeckas
changed the title
|
The failed test is also present in PR #255 - I suspect it is not caused by this PR (as no functional code is changed). |
Check comments
Checked comments, replaced some unused keywords with ``**kwargs``.
File checked
|
These are probably the hardest files, thanks @KostasValeckas! The method docstrings are all fine, eventually it would probably need some more prose documentation for RTD, but this looks great for now. |
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.
Updated docs and formatting for
multifit.pyandprep.py.This is a continuation from PR's #229, #240 and #246 as agreed with @gbrammer .
Specifically:
added missing / completed incomplete docstrings using AI tools.
went through formatting using black.
adressed some unused parameters
Some unused parameters or ambiguities are marked with TODO comments. All AI-inspired docs are marked with a note in the docstring.