Skip to content

Correct example commands and output in README to reflect actual behavior of tool #16

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

Merged
merged 1 commit into from
May 25, 2022
Merged

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented May 18, 2022

The readme content seems to be based on the "dummy-monitor" tool rather than on serial-monitor, and also outdated.

I have updated the commands and output to reflect the behavior of the tool from this repository.

The exception are some differences that are caused by bugs in the github.com/arduino/pluggable-monitor-protocol-handler tool:

The new readme content is written in expectation of specification compliance rather than reflecting the current buggy behavior.

@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: documentation Related to documentation for the project labels May 18, 2022
@per1234 per1234 requested a review from umbynos May 18, 2022 06:11
@per1234 per1234 self-assigned this May 18, 2022
@per1234
Copy link
Contributor Author

per1234 commented May 18, 2022

I think we should wait on a decision on arduino/arduino-cli#1738 before merging this. It might be that the specification will be judged incorrect rather than the module behavior. The current readme is 50/50 on use of values vs value as the key name, so it will need to be updated either way to be made correct.

@per1234 per1234 removed the request for review from umbynos May 18, 2022 06:54
@per1234 per1234 added the status: blocked Progress on this prevented by an external cause label May 18, 2022
…ior of tool

The readme content seems to be based on the "dummy-monitor" tool rather than on serial-monitor, and also outdated.

I have updated the commands and output to reflect the behavior of the tool from this repository.
@per1234 per1234 removed the status: blocked Progress on this prevented by an external cause label May 25, 2022
@per1234 per1234 requested a review from umbynos May 25, 2022 07:39
@per1234 per1234 merged commit a977a70 into arduino:main May 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants