Skip to content
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

Updated documentation about arduino-cli integration options. #2605

Merged
merged 2 commits into from
May 15, 2024

Conversation

cmaglie
Copy link
Member

@cmaglie cmaglie commented May 15, 2024

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?

Fixed documentation about integration options for arduino-cli.

What is the current behavior?

What is the new behavior?

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

Other information

fix #2543

@cmaglie cmaglie self-assigned this May 15, 2024
@cmaglie cmaglie added type: enhancement Proposed improvement topic: documentation Related to documentation for the project labels May 15, 2024
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.

LGTM

I've also tested the 2 examples on Ubuntu while having the daemon running. Everything is working flawlessly! 🚀

Copy link

codecov bot commented May 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.12%. Comparing base (e7e11dc) to head (ce95ac5).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2605      +/-   ##
==========================================
- Coverage   70.13%   70.12%   -0.02%     
==========================================
  Files         222      222              
  Lines       21124    21124              
==========================================
- Hits        14816    14813       -3     
- Misses       5132     5134       +2     
- Partials     1176     1177       +1     
Flag Coverage Δ
unit 70.12% <ø> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@cmaglie cmaglie merged commit 98d1a7a into arduino:master May 15, 2024
104 checks passed
@cmaglie cmaglie deleted the fix_docs branch May 15, 2024 14:53
@per1234 per1234 added type: imperfection Perceived defect in any part of project and removed type: enhancement Proposed improvement labels May 15, 2024
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.

[cli] fix doc about API
3 participants