Skip to content
This repository was archived by the owner on Aug 2, 2022. It is now read-only.
This repository was archived by the owner on Aug 2, 2022. It is now read-only.

Shell commands in README.md should not start with $ or # #8787

Open

Description

@lparisc

File: README.md

Shell commands contained in codeblocks (used for documentation purposes) should not start with an explicit $ or # character.

Rationale:

  • Eventually, the documentation generator tool will display a shell prompt character by default ($ or # depending on the case), so it's better not to add it explicitly to avoid unnecessary duplication.
  • The leading shell prompt character added by the tool won't be copy/paste-able, which will simplify reproduction of the shell command(s) on a shell terminal and avoid re-editing altogether.

Fix suggestion:

  • Make sure shell codeblocks use "sh" or "shell"
  • Remove leading $ or # char from shell codeblocks

Activity

  1. added
    documentationRequires attention from documentation team. e.g. documentation is expected to be generated.
    on Mar 9, 2020
  2. self-assigned this
    on Mar 9, 2020
  3. changed the title [-]Shell commands in docs should not start with $ or #[/-] [+]Shell commands in README.md should not start with $ or #[/+] on Mar 9, 2020
  4. added
    stagingdoc-related issue has been resolved in merged PR. moved to staging phase for production testing.
    on Apr 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationRequires attention from documentation team. e.g. documentation is expected to be generated.stagingdoc-related issue has been resolved in merged PR. moved to staging phase for production testing.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions