doc: Use Numpydoc standard #101
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #101 +/- ##
=======================================
Coverage 60.06% 60.06%
=======================================
Files 12 12
Lines 2454 2454
=======================================
Hits 1474 1474
Misses 980 980
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
arokem
left a comment
arokem
left a comment
There was a problem hiding this comment.
Great - thanks for doing this! I had some small suggestions, many of which are potentially too much, but take a look.
trx/workflows.py
Outdated
|
|
||
| Returns | ||
| ------- | ||
| nibabel.streamlines.ArraySequence |
There was a problem hiding this comment.
| nibabel.streamlines.ArraySequence | |
| nibabel.streamlines.ArraySequence class instance |
trx/workflows.py
Outdated
|
|
||
| Parameters | ||
| ---------- | ||
| streamlines : ArraySequence |
There was a problem hiding this comment.
| streamlines : ArraySequence | |
| streamlines : ArraySequence class instance |
trx/workflows.py
Outdated
|
|
||
| Returns | ||
| ------- | ||
| ArraySequence or None |
There was a problem hiding this comment.
| ArraySequence or None | |
| ArraySequence class instance or None |
trx/workflows.py
Outdated
| Temporary directory where header.json is written. | ||
| reference : str | ||
| Reference anatomy used to derive affine and dimensions. | ||
| streamlines : ArraySequence |
There was a problem hiding this comment.
| streamlines : ArraySequence | |
| streamlines : ArraySequence class instance |
trx/workflows.py
Outdated
| ---------- | ||
| tmp_dir_name : str | ||
| Temporary directory to store binary arrays. | ||
| streamlines : ArraySequence |
There was a problem hiding this comment.
| streamlines : ArraySequence | |
| streamlines : ArraySequence class instance |
arokem
left a comment
arokem
left a comment
There was a problem hiding this comment.
Great - thanks for doing this! I had some small suggestions, many of which are potentially too much, but take a look.
skoudoro
force-pushed
the
numpydoc-standard
branch
from
4687f63 to
056fdd7
Compare
… information. Co-authored-by: Ariel Rokem <arokem@gmail.com>
skoudoro
force-pushed
the
numpydoc-standard
branch
from
056fdd7 to
4610e54
Compare
|
Thanks for the review @arokem , it is ready to go |
2 participants
fixed #43
This pull request focuses on standardizing docstring.
These changes will help ensure code clarity, improve maintainability, and enforce consistent documentation standards.
ruffandcodespell, and added anumpydocvalidation hook to.pre-commit-config.yamlto enforce docstring standards automatically.[tool.numpydoc_validation]section topyproject.tomlto configure docstring validation rules, exclusions, and overrides.