mirror of
https://github.com/tldr-pages/tldr.git
synced 2026-08-30 17:33:50 +08:00
style-guide: add instructions for when a command is run in interactive mode (#20042)
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
This commit is contained in:
@@ -327,6 +327,9 @@ Whereas for Powershell, prepend the environment variable with a dollar sign, Env
|
||||
|
||||
When describing file formats, primarily use the brand name in plain text (e.g. JSON, SQLite), or use the file extension preceded by a dot, wrapped in backticks (e.g. `.txt`).
|
||||
|
||||
If the command that is being described is part of an interactive mode, mention the word "interactive" in a previous example that enters said mode and mark the beginning of the description for the interactive commands with `[Interactive]`.
|
||||
Interactive mode can be defined as running commands within the command the page describes, and the prompt not having access to programs in $PATH.
|
||||
|
||||
### Standardized Terms
|
||||
|
||||
Some terms are used repeatedly throughout pages, and as such, should be standardized. These include:
|
||||
|
||||
Reference in New Issue
Block a user