Skip to content

adding example usage for command option #1753

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

TZubiri
Copy link

@TZubiri TZubiri commented Jun 8, 2022

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:

arduino-cli monitor --baudrate 1000000

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

-c, --config strings

to

-c --config ID=Setting

in addition to clarifying the syntax, it also points the user towards the --describe keywords.

Thank you.
Tom

I don't think this is a source file though.
@CLAassistant
Copy link

CLAassistant commented Jun 8, 2022

CLA assistant check
All committers have signed the CLA.

@per1234 per1234 self-assigned this Jun 9, 2022
@per1234 per1234 added type: enhancement Proposed improvement topic: documentation Related to documentation for the project labels Jun 9, 2022
Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution @TZubiri.

This file is automatically generated so it can not be edited directly. You must instead edit the source string at the path and line indicated by the comment:

#: cli/monitor/monitor.go:63

here:

monitorCommand.Flags().StringSliceVarP(&configs, "config", "c", []string{}, tr("Configuration of the port."))

Any edits made to this en.po file would only be overwritten by the automated system on the next sync.

I have submitted a proposal to more effectively communicate this fact to contributors: #1837
I welcome any feedback you might have on that proposal, so feel free to review that PR

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants