Fixed formatting for run-test command in getting started.
Removed shell sign where no command output provided.
Details
- Reviewers
thopre cmatthews PrzemekWirkus
Diff Detail
- Build Status
Buildable 61703 Build 75194: arc lint + arc unit
Event Timeline
docs/quickstart.rst | ||
---|---|---|
65 | Difficult to see in Phabricator but that still doesn't look like the same spacing as say the git clone above. It's also the only command with a prompt so perhaps you could remove the prompt and use the same indentation as the git clone and other commands below? |
I didn't realize there was other cases of prompt in other documentation files. Seeing some of those cases mix command invocation and its output and seeing how there are many cases of prompt already, it might be preferable to do it the other way around: use a prompt everywhere. If there are also lots of cases to convert to use a prompt, please do post a command before doing all the work.
Yes, there are more than 20 cases of using command without a prompt sign. It's much more than the ones that used. Do you suppose it's better to convert them all?
I think when a command is also shown along its output using a prompt makes sense. From there we could either convert everything to use a prompt (more work) or only use a prompt when there is a command is shown along its output because there would be ambiguity (less work but a bit less consistent). I'm fine with both, perhaps let's make sure prompt is only used where the output of the command is also shown. How many examples would need to be fixed?
I've found 7 such cases. Restored shell sign at the places where command output was provided.
LGTM once you've updated the description to mention you've removed shell sign only when there's no output.
Difficult to see in Phabricator but that still doesn't look like the same spacing as say the git clone above. It's also the only command with a prompt so perhaps you could remove the prompt and use the same indentation as the git clone and other commands below?