Skip to content

[skip changelog] Always mention "user directory" along with "sketchbook" in documentation #816

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
Jul 10, 2020
Merged

[skip changelog] Always mention "user directory" along with "sketchbook" in documentation #816

merged 1 commit into from
Jul 10, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jul 10, 2020

Arduino IDE and Arduino Web Editor use the term "sketchbook", while Arduino CLI and Arduino Pro IDE use the term "user directory". In order for the documentation to be friendly to all users of Arduino's development software, both terms must be used in the documentation.

Please check if the PR fulfills these requirements

  • 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)
  • What kind of change does this PR introduce?

docs update

  • What is the current behavior?

In a couple places, the documentation uses only the term "sketchbook". Arduino IDE and Arduino Web Editor use the term "sketchbook", while Arduino CLI and Arduino Pro IDE use the term "user directory". In order for the documentation to be friendly to all users of Arduino's development software, both terms must be used.

  • What is the new behavior?

"User directory" is always mentioned in conjunction with the use of the term "sketchbook" in the documentation.

  • Does this PR introduce a breaking change?

No

@per1234 per1234 added the topic: documentation Related to documentation for the project label Jul 10, 2020
Arduino IDE and Arduino Web Editor use the term "sketchbook", while Arduino CLI and Arduino Pro IDE use the term "user directory". In order for the documentation to be friendly to all users of Arduino's development software, both terms must be used in the documentation.
@per1234 per1234 merged commit e7638c7 into arduino:master Jul 10, 2020
@per1234 per1234 deleted the sketchbook-and-user-directory branch July 10, 2020 12:07
@per1234 per1234 self-assigned this Nov 23, 2021
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants