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

Standardize CLI examples #893

Open
Open
@pop

Description

@pop

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.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions