-
Notifications
You must be signed in to change notification settings - Fork 22
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
Update readmes #282
Conversation
Codecov Report
@@ Coverage Diff @@
## main #282 +/- ##
=======================================
Coverage 93.44% 93.44%
=======================================
Files 34 34
Lines 2028 2028
=======================================
Hits 1895 1895
Misses 133 133
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 |
api/python/cell_census/README.md
Outdated
|
||
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/). |
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.
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
api/r/CellCensus/README.md
Outdated
|
||
**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/). |
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.
same suggestion as in the Python API readme - spell out the repo
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.
Two very small suggestions, no other concerns.
Addresses #230 #231
Updates and makes consistent the following: