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

Copyedit notebooks to improve explanations and be more formal/less colloquial #94

Open
chmreid opened this issue Dec 19, 2019 · 0 comments
Assignees

Comments

@chmreid
Copy link
Collaborator

chmreid commented Dec 19, 2019

Notebooks as written are too colloquial, and should be more formal - "you/me/I" references and contractions should be removed, section titles hsould be clarified.

Clear, high-level explanations of what a notebook is demonstrating, who a notebook is for, or what is actually happening in the notebook are missing from some notebooks.

More clearly pointing readers to the HCA CLI and HCA API tutorials (see HumanCellAtlas/dcp-cli readthedocs page) would also be helpful.

@chmreid chmreid self-assigned this Dec 20, 2019
@chmreid chmreid changed the title Rewrite notebooks to improve explanations and be more formal/less colloquial Copyedit notebooks to improve explanations and be more formal/less colloquial Dec 21, 2019
@chmreid chmreid added this to the Q1 2020 Milestone 1 milestone Jan 7, 2020
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

No branches or pull requests

1 participant