Skip to content

Remove redundant spaces from comment text #59

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
Apr 18, 2022
Merged

Remove redundant spaces from comment text #59

merged 1 commit into from
Apr 18, 2022

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Apr 18, 2022

Some redundant spaces were present in the comments

Some of these followed a period. Although two spaces after a period were sometimes recommended in previous eras, modern practice is universally a single space:

https://www.chicagomanualofstyle.org/qanda/data/faq/topics/OneSpaceorTwo/faq0006.html

Regardless of whether it is correct according to standard practice, it might be reasonable to retain double spaces if this were a well established convention in the project. That is not the case here. The majority of the content uses only a single space, so the double spaces are inconsistent in addition to being incorrect.

There were also some occurrences of redundant spaces within sentences, which is never correct.

Resolves (partially) #8

Some redundant spaces were present in the comments

Some of these followed a period. Although two spaces after a period were sometimes recommended in previous eras, modern
practice is universally a single space:

https://www.chicagomanualofstyle.org/qanda/data/faq/topics/OneSpaceorTwo/faq0006.html

Regardless of whether it is correct according to standard practice, it might be reasonable to retain double spaces if
this were a well established convention in the project. That is not the case here. The majority of the content uses only
a single space, so the double spaces are inconsistent in addition to being incorrect.

There were also some occurrences of redundant spaces within sentences, which is never correct.
@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: documentation Related to documentation for the project labels Apr 18, 2022
@per1234 per1234 merged commit c2214cd into arduino-libraries:master Apr 18, 2022
@per1234 per1234 mentioned this pull request Apr 19, 2022
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.

1 participant