fixing return types of some methods and updating their docstrings #325
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
arik-shurygin
added a commit
that referenced
this pull request
Jan 16, 2025
* checkpoint revamping comments on most of dynode except for utils and vis_utils * checkpoint more comment work * more conscise comments * fixing comments vis_utils * comment concise abstract_parameters * fixing return types of some methods and updating their docstrings (#325) * all functions now return instead of updating self * small bugfix * fixing mypy * checkpoint using pydocstyle to format comments on first four files, __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 * mypy bugfix * pydocstyle covid_sero_initializer.py * small tweaks to dynode_runner since many methods are being moved out in a different PR * pydocstyle mechanistic_inferer.py * pydocstyle mechanistic_runner.py * pydocstyle static_value_parameters.py * pydocstyle utils.py * pydocstyle vis_utils.py * Notes section does not need to be indented * adding --convention=numpy flag to pydocstyle to also check numpy conventions of methods * note->notes in comment
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.
many methods were updating
selfinstead of returning the value, this is bad practice as it is a side effect and means the order in which methods are run can change results. This also had direct impacts on the effort to refactor method docstrings asModifiesis not a section in the numpy format.Merging this PR in with #323 so that further docstring compliance can be done with the new method headers.