docs: Update documentation#2832
Conversation
|
|
||
| ```console | ||
| $ vcsim -h # pruned to model type flags used in the Examples section | ||
| vcsim -h # pruned to model type flags used in the Examples section |
There was a problem hiding this comment.
The nice thing about console + $ command prefix is you can clearly see the commands vs output. Compare the current: https://github.com/vmware/govmomi/tree/master/vcsim#usage
The command and comment are colorized black+grey, output is blue. This is esp. useful when a console section contains multiple commands+outputs.
To w/o the $, all text is blue: https://github.com/vmware/govmomi/blob/c235e4f3282f4f1cee09b7224388b7cd2a30cc9d/vcsim/README.md#usage
I would prefer to keep console+prompt in the sections where include the output. Ok with me to remove the prompt where we don't include any output. But, in those cases you'd probably want to change console to bash, so we get the consistent color (black vs blue).
ex see current black: https://github.com/vmware/govmomi/tree/master/vcsim#install-via-go-get
vs pr blue: https://github.com/vmware/govmomi/blob/c235e4f3282f4f1cee09b7224388b7cd2a30cc9d/vcsim/README.md#install-via-go-install
There was a problem hiding this comment.
Makes sense, wasn't aware of these little subtleties :)
There was a problem hiding this comment.
Changed all non-output lines to bash, reverted back the commands with output to console prefixed by $
Closes: vmware#2830 Signed-off-by: Michael Gasch <mgasch@vmware.com>
|
I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues. If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
Description
$from docs for easy copy and pastegoversionsCloses: #2830
Signed-off-by: Michael Gasch mgasch@vmware.com
Type of change
Please mark options that are relevant:
not work as expected)
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. If applicable, please also list any relevant
details for your test configuration.
Checklist:
this project