Skip to content
This repository has been archived by the owner on Feb 12, 2021. It is now read-only.

Standardize CLI examples #893

Open
pop opened this issue Oct 11, 2016 · 0 comments
Open

Standardize CLI examples #893

pop opened this issue Oct 11, 2016 · 0 comments

Comments

@pop
Copy link
Contributor

pop commented Oct 11, 2016

As the style guide says we should be using $ to denote commands and (hopefully) show some example output. I usually try to avoid nit-picking with the style guide, but this really helps other users (and me) understand:

  • Is this a command I'm supposed to be typing?
  • What should happen when this is run?

Written context can also accomplish this, but adding a prompt and some output reduces confusion greatly. We should retroactively fix discrepancies with this and be better slickers about standardizing this going forward.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant