adding example usage for command option #1753
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello, please take a look at this small documentation change.
Basically I struggled for a while to figure out why the monitor wasn't working, and I had to play with the IDE to understand that I needed to match the baud rates.
I'm adding a really low effort change that might help users work out how to use the
-c
option once they figured out they need to change the baud rate.Ideally I think the options should be collapsed into command line flags so that the following works:
But for now I think this small change can be pulled, if it can be tested by someone with a working build.
If possible, I would also change the flag usage from
to
in addition to clarifying the syntax, it also points the user towards the
--describe
keywords.Thank you.
Tom