NumPy Docstrings #295
Draft
NumPy Docstrings #295
Conversation
This file contains hidden or 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
Is this necessary? I have been trying to restrict the proliferation of dev tooling config files. |
|
In general, please limit the diff to the absolute minimum, and keep PRs single-purpose. |
Not necessary, but I find the separation to be nice for organization. |
Can you revert this change? |
Sure |
- Fixed conflicts in data modules (combined.py, triplet.py, hcs.py) - Resolved classification.py parameter conflicts - Updated transforms __init__.py imports - Cleaned up _transforms.py duplicate classes
srivarra
force-pushed
the
docs/standardize-numpydocstrings
branch
from
100a2be to
b6635d4
Compare
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.
Converts docstrings to NumPy.
Updated the
tool.ruffsection in thepyproject.toml. Primary changes here are addingnumpydocas thepydocstyleconvention. Ignored a few rules to keep things reasonably sane.ruffignoresviscy/scripts,applications/andexamples/currently. ExpandedI001to include all of theisortrules.Added docstrings to public functions which didn't have them as the rule would throw errors for public classes, methods and functions otherwise. Some private methods and classes had docstrings and those were adjusted.
Converted the existing sphinx style docstrings to NumPy the style.
There are a handful of type hint fixes as well, but these are not super thorough and were the result of aligning docs.
I'm sure the contents of some of these are not completely accurate. We can either change the incorrect ones in this pr or in another.