chanzuckerberg / cellxgene-census

CZ CELLxGENE Discover Census
https://chanzuckerberg.github.io/cellxgene-census/
MIT License
79 stars 20 forks source link

[docs] Fix docstrings for various functions #1002

Closed martinkim0 closed 7 months ago

martinkim0 commented 7 months ago

Changes include fixing some typos, adding or removing whitespaces for correct rendering of docs, and changing get_census_version_directory to use Args: instead of Params:.

martinkim0 commented 7 months ago

For whoever reviews this: is there a particular reason that intersphinx mappings are not used in some parts of the docs such as here? Otherwise, I can add changes for those in this PR too.

bkmartinjr commented 7 months ago

particular reason that intersphinx mappings are not used

To my knowledge, lack of clue on our part and lack of a linter in our CI.

Very happy to take the PR changes.

codecov[bot] commented 7 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (d650a96) 86.01% compared to head (d28f136) 86.01%. Report is 2 commits behind head on main.

:exclamation: Current head d28f136 differs from pull request most recent head 75d3f97. Consider uploading reports for the commit 75d3f97 to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1002 +/- ## ======================================= Coverage 86.01% 86.01% ======================================= Files 71 71 Lines 5647 5647 ======================================= Hits 4857 4857 Misses 790 790 ``` | [Flag](https://app.codecov.io/gh/chanzuckerberg/cellxgene-census/pull/1002/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=chanzuckerberg) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/chanzuckerberg/cellxgene-census/pull/1002/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=chanzuckerberg) | `86.01% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=chanzuckerberg#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

martinkim0 commented 7 months ago

@bkmartinjr Thanks for taking a look! I'll add the additional changes

bkmartinjr commented 7 months ago

BTW, if you know of a linter that would catch missing formatting (e.g., single quotes vs double), happy to add it to the CI

martinkim0 commented 7 months ago

We use the Ruff linter on our end - I can put in a PR for that if that works for you!

bkmartinjr commented 7 months ago

We have ruff in our pre-commits. But at least as configured it doesn't flag this stuff for us. Happy to take a PR!! Many thanks