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.

Sign up for GitHub

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

Jump to bottom

Decide and stick to a writing style #124

Open
nventuro opened this issue Jan 17, 2020 · 0 comments
Open

Decide and stick to a writing style #124

nventuro opened this issue Jan 17, 2020 · 0 comments

Comments

@nventuro
Copy link
Contributor

In OpenZeppelin/openzeppelin-contracts#2058, @frangio mentioned he doesn't agree with some aspects of the current writing style in our docs, including:

  • having colons before a list starts
  • capitalizing after colons on enumerations (like in the 'next steps' sections)
  • including $ in console code snippets

We should settle on a writing style and use it throughout our docs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@nventuro