forked from carpentries-incubator/pando-python
generated from carpentries/workbench-template-md
-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
Items raised whilst working through @JostMigenda's additions.
- Title case
- long numbers in code (e.g. break them up with
_) - quote style (e.g. regular vs typographic quotes)
- x vs multiplication symbol
- referring to functions (from code examples) in the text (e.g.
foo()rather thanfoo) - avoid first person
- Prefer to avoid raw links, (e.g. link some descriptive text instead, carpentries CI will nag if the text is just here)
Not sure what else would be relevant.
Then we'd obviously need to review the site to check they're implemented.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels