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 readmes #282

Merged
merged 3 commits into from
Mar 23, 2023
Merged

Update readmes #282

merged 3 commits into from
Mar 23, 2023

Conversation

pablo-gar
Copy link
Contributor

Addresses #230 #231

Updates and makes consistent the following:

@pablo-gar pablo-gar marked this pull request as ready for review March 22, 2023 22:55
@codecov
Copy link

codecov bot commented Mar 22, 2023

Codecov Report

Merging #282 (29d2da4) into main (2c1b55e) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #282   +/-   ##
=======================================
  Coverage   93.44%   93.44%           
=======================================
  Files          34       34           
  Lines        2028     2028           
=======================================
  Hits         1895     1895           
  Misses        133      133           
Flag Coverage Δ
unittests 93.44% <ø> (ø)

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

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more


The `cell_census` package provides an API to facilitate use of the CZI Science Cell Census. The Cell Census is a versioned container for the single-cell data hosted at [CELLxGENE Discover](https://cellxgene.cziscience.com/).
The `cell_census` package provides an API to facilitate the use of the CZ CELLxGENE Discover Cell Census. For more information about the API and the project visit the [github repo](https://github.com/chanzuckerberg/cell-census/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tiny nit: it is best practice to actually display the repo name, as the contents may not be read in a browser.

Suggested change:

visit the chanzuckerberg/cell-census GitHub repo


**Status**: Pre-release, under rapid development. Expect API changes.
The `CellCensus` package provides an API to facilitate the use of the CZ CELLxGENE Discover Cell Census. For more information about the API and the project visit the [github repo](https://github.com/chanzuckerberg/cell-census/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same suggestion as in the Python API readme - spell out the repo

Copy link
Contributor

@bkmartinjr bkmartinjr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two very small suggestions, no other concerns.

@pablo-gar pablo-gar merged commit 91d7a12 into main Mar 23, 2023
@pablo-gar pablo-gar deleted the pablo-gar/update-package-readmes branch March 23, 2023 01:12
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.

2 participants