-
Notifications
You must be signed in to change notification settings - Fork 896
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Update documentation #2832
Conversation
vcsim/README.md
Outdated
@@ -78,7 +78,7 @@ flags. Resources can also be created and removed using the API. In fact, vcsim | |||
itself uses the vSphere API generate its inventory. | |||
|
|||
```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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense, wasn't aware of these little subtleties :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm, thanks!
Description
$
from docs for easy copy and pastego
versionsCloses: #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