-
Notifications
You must be signed in to change notification settings - Fork 35
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update doc style #185
Update doc style #185
Conversation
note, i fixed a couple missing args in noise_removal
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@gwaygenomics I found a few Returns
missing in the docstrings. I have highlighted those. Apart from that, as you probably know already, some functions have helpful examples in the docstring while others don't. Perhaps we should make it a task for version 0.2.
Lastly, in pycytominer/cyto_utils/load.py
docstrings should say Parameters
instead of Arguments
and Returns
instead of Return
. Also load_npz()
is missing Returns
.
Everything else looks good.
Co-authored-by: Niranj Chandrasekaran <[email protected]>
Co-authored-by: Niranj Chandrasekaran <[email protected]>
Codecov Report
@@ Coverage Diff @@
## master #185 +/- ##
==========================================
- Coverage 98.07% 98.04% -0.03%
==========================================
Files 52 50 -2
Lines 2438 2403 -35
==========================================
- Hits 2391 2356 -35
Misses 47 47
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
Thanks for the careful review @niranjchandrasekaran - I've addressed all your comments, and will now merge! |
Description
Closes #180
@niranjchandrasekaran - can you check this PR closely? By closely I also mean if I missed updating any functions.
What is the nature of your change?
Checklist
Please ensure that all boxes are checked before indicating that a pull request is ready for review.