Skip to content
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

Merged
merged 15 commits into from
Feb 4, 2022
Merged

Update doc style #185

merged 15 commits into from
Feb 4, 2022

Conversation

gwaybio
Copy link
Member

@gwaybio gwaybio commented Feb 2, 2022

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?

  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • This change requires a documentation update.

Checklist

Please ensure that all boxes are checked before indicating that a pull request is ready for review.

  • I have read the CONTRIBUTING.md guidelines.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • New and existing unit tests pass locally with my changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have deleted all non-relevant text in this pull request template.

Copy link
Member

@niranjchandrasekaran niranjchandrasekaran left a 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.

pycytominer/cyto_utils/modz.py Outdated Show resolved Hide resolved
pycytominer/cyto_utils/modz.py Outdated Show resolved Hide resolved
pycytominer/cyto_utils/output.py Show resolved Hide resolved
pycytominer/operations/transform.py Show resolved Hide resolved
@codecov-commenter
Copy link

Codecov Report

Merging #185 (442219e) into master (1279cd2) will decrease coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            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              
Flag Coverage Δ
unittests 98.04% <ø> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
pycytominer/consensus.py 100.00% <ø> (ø)
pycytominer/cyto_utils/annotate_custom.py 96.87% <ø> (ø)
pycytominer/cyto_utils/cells.py 96.26% <ø> (ø)
pycytominer/cyto_utils/load.py 88.00% <ø> (ø)
pycytominer/cyto_utils/modz.py 97.14% <ø> (ø)
pycytominer/cyto_utils/output.py 100.00% <ø> (ø)
pycytominer/cyto_utils/single_cell_ingest_utils.py 100.00% <ø> (ø)
pycytominer/cyto_utils/write_gct.py 100.00% <ø> (ø)
pycytominer/feature_select.py 94.59% <ø> (ø)
pycytominer/operations/__init__.py 100.00% <ø> (ø)
... and 5 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1279cd2...442219e. Read the comment docs.

@gwaybio
Copy link
Member Author

gwaybio commented Feb 4, 2022

Thanks for the careful review @niranjchandrasekaran - I've addressed all your comments, and will now merge!

@gwaybio gwaybio merged commit 48af26a into cytomining:master Feb 4, 2022
@gwaybio gwaybio deleted the update-doc-style branch February 4, 2022 23:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consistent documentation
3 participants