You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 2, 2022. It is now read-only.
Repository navigation
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
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.
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
Activity
[-]Shell commands in docs should not start with $ or #[/-][+]Shell commands in README.md should not start with $ or #[/+]