Docstring compliance #323
Merged
Docstring compliance #323
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
|
bringing back into drafts to implement |
* all functions now return instead of updating self * small bugfix * fixing mypy
…_init__.py, abstract_initializer.py, abstract_parameters.py, and config.py. Had to make many config functions private to avoid numpy comments on 1 liners
…in a different PR
…entions of methods
cdc-ap66
approved these changes
Jan 16, 2025
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.
pydocstyleto ensure method comments follow PEP257 guidelinesselffrom within the method.This PR will make future revamps easier and is a part of general repo maintenance in preparation for v1.0 overhaul.
Some functions were left untouched because they will likely be drastically changed by GH issues like #319 #321 #318 or are soon to be deprecated and removed.
CLOSES #313