Skip to content

[skip changelog]Use standardized term for Boards Manager in documentation #930

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
Aug 31, 2020
Merged

[skip changelog]Use standardized term for Boards Manager in documentation #930

merged 1 commit into from
Aug 31, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Aug 31, 2020

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?

The term "Boards Manager" has been well established in the Arduino development tools and documentation. Perhaps influenced by the mismatch with the singular term used for its companion "Library Manager", Arduino CLI's documentation has diverged from this standard by sometimes (but not always) referring to it as "Board Manager".

  • What is the new behavior?

Boards Manager is always referred to by the standardized term in the documentation.

  • Does this PR introduce a breaking change?

No

  • Other information:

Note that "Boards Manager" and "Library Manager" are proper nouns, and so should always be capitalized.

…tion

The term "Boards Manager" has been well established in the Arduino development tools and documentation. Perhaps influenced by the mismatch with the singular term used for its companion "Library Manager", Arduino CLI's documentation has diverged from this standard by sometimes (but not always) referring to it as "Board Manager". This PR resolves the inconsistency by using "Boards Manager" everywhere.

Note that "Boards Manager" and "Library Manager" are proper nouns, and so should always be capitalized.
@per1234 per1234 added the topic: documentation Related to documentation for the project label Aug 31, 2020
@per1234 per1234 requested a review from ubidefeo August 31, 2020 04:35
@per1234 per1234 merged commit 06c9503 into arduino:master Aug 31, 2020
@per1234 per1234 deleted the use-boards-manager-term branch August 31, 2020 13:59
@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