Page MenuHomePhabricator

[LNT][docs] Fixed docs consistency
AcceptedPublic

Authored by nkbolg on Jun 25 2020, 5:37 AM.

Details

Summary

Fixed formatting for run-test command in getting started.
Removed shell sign where no command output provided.

Event Timeline

nkbolg created this revision.Jun 25 2020, 5:37 AM
nkbolg edited the summary of this revision. (Show Details)Jun 25 2020, 6:51 AM
thopre added inline comments.Jun 25 2020, 9:28 AM
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?

nkbolg updated this revision to Diff 273450.Jun 25 2020, 10:43 AM
  • [LNT][docs] docs consistency fix
nkbolg edited the summary of this revision. (Show Details)Jun 25 2020, 10:45 AM
nkbolg marked an inline comment as done.
  • [LNT][docs] docs consistency fix

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.

nkbolg marked an inline comment as done.Jun 25 2020, 11:27 AM
This comment was removed by nkbolg.
docs/quickstart.rst
65

Done.
Also removed prompts from other command examples for consistency.

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?

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?

nkbolg updated this revision to Diff 274507.Jun 30 2020, 8:50 AM
  • [LNT][docs] docs restored shell sign for examples with output

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.

thopre accepted this revision.Jun 30 2020, 9:14 AM

LGTM once you've updated the description to mention you've removed shell sign only when there's no output.

This revision is now accepted and ready to land.Jun 30 2020, 9:14 AM
nkbolg retitled this revision from [LNT][docs] Fix indentation to [LNT][docs] Fixed docs indentation.Jun 30 2020, 11:12 AM
nkbolg edited the summary of this revision. (Show Details)
nkbolg retitled this revision from [LNT][docs] Fixed docs indentation to [LNT][docs] Fixed docs consistency.
nkbolg edited the summary of this revision. (Show Details)