Skip to content

[skip changelog]Make general minor improvements to the wording of the documentation #906

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 2 commits into from
Aug 19, 2020
Merged

[skip changelog]Make general minor improvements to the wording of the documentation #906

merged 2 commits into from
Aug 19, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Aug 19, 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?

Some of the wording of the documentation is less clear or readable than it might be.

  • What is the new behavior?

The wording of the documentation is improved without any significant changes to the informational content.

  • Does this PR introduce a breaking change?

No

The information about architecture values being case sensitive was placed in the middle of a largely unrelated paragraph.

The paragraph about using standardized architecture names had an overly strident tone, which I have softened.
Do some minor rewording of sentences to improve clarity and readability, but without changing their informational content.
@per1234 per1234 added the topic: documentation Related to documentation for the project label Aug 19, 2020
@per1234 per1234 merged commit 495966e into arduino:master Aug 19, 2020
@per1234 per1234 deleted the improve-docs-wording branch August 19, 2020 14:42
@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