Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

[skip-changelog] Add output.no_color to configuration docs #2246

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
MatteoPologruto merged 2 commits into arduino:master from MatteoPologruto:no-color-docs
Jul 20, 2023

Conversation

Copy link
Contributor

@MatteoPologruto MatteoPologruto commented Jul 18, 2023 •
edited
Loading

Please check if the PR fulfills these requirements

See how to contribute

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • configuration.schema.json updated if new parameters are added.

What kind of change does this PR introduce?

Documentation enhancement

What is the new behavior?

An explanation for the configuration key output.no_color has been added to the docs.

Does this PR introduce a breaking change, and is titled accordingly?

No

per1234 reacted with thumbs up emoji
@MatteoPologruto MatteoPologruto added type: enhancement Proposed improvement topic: documentation Related to documentation for the project labels Jul 18, 2023
@MatteoPologruto MatteoPologruto changed the title (削除) [skip-changelog] Add output.no_color to configuration docs (削除ここまで) (追記) [skip-changelog] Add output.no_color to configuration docs (追記ここまで) Jul 18, 2023
@MatteoPologruto MatteoPologruto marked this pull request as ready for review July 18, 2023 15:59
@MatteoPologruto MatteoPologruto linked an issue Jul 18, 2023 that may be closed by this pull request
3 tasks
Copy link
Contributor

@alessio-perugini alessio-perugini left a comment

Choose a reason for hiding this comment

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

image
☝️ no colored LGTM 😝

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.

I would suggest also adding these properties to https://github.com/arduino/arduino-cli/blob/master/configuration/configuration.schema.json

It could be argued that is out of scope for the PR that is only intended to update the docs, but it seems the approach taken during the creation of the schema was to provide coverage only for the documented configuration properties rather than all the properties implemented in the Arduino CLI codebase.

The documentation looks perfect.

MatteoPologruto reacted with thumbs up emoji kittaakos reacted with heart emoji
Copy link
Contributor Author

Thanks for the suggestion @per1234! I updated the configuration.schema.json in a new commit.
kittaakos reacted with heart emoji

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 Matteo!

@MatteoPologruto MatteoPologruto merged commit 0727686 into arduino:master Jul 20, 2023
@MatteoPologruto MatteoPologruto deleted the no-color-docs branch July 20, 2023 11:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@per1234 per1234 per1234 approved these changes

+2 more reviewers

@alessio-perugini alessio-perugini alessio-perugini approved these changes

@umbynos umbynos umbynos approved these changes

Reviewers whose approvals may not affect merge requirements
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

output.no_color is missing from the spec

AltStyle によって変換されたページ (->オリジナル) /