Skip to content

Fix typos in documentation #44

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 4 commits into from
May 28, 2024
Merged

Fix typos in documentation #44

merged 4 commits into from
May 28, 2024

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented May 28, 2024

The codespell spellchecker tool is used to automatically detect commonly misspelled words in the files of this project.

The misspelled words dictionary was expanded in the latest release of codespell, which resulted in the detection of a
misspelled word in the project's comments:

https://github.com/arduino-libraries/ArduinoGraphics/actions/runs/9265729402

spellcheck: docs/readme.md#L3
interfacce ==> interface

The typo is hereby corrected, which will restore the spell check to a passing state.


I supplemented the correction of the automatically detected typo with a comprehensive manual review of all documentation content in the project and also corrected all additional typos I identified during that review.

per1234 added 4 commits May 28, 2024 02:26
Previously, the documentation contained a large number of unnecessary blank lines.

Since these serve no purpose and give the source content an unprofessional and sloppy appearance, they are removed.
@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: documentation Related to documentation for the project labels May 28, 2024
@per1234 per1234 self-assigned this May 28, 2024
@per1234 per1234 merged commit 7709e46 into arduino-libraries:master May 28, 2024
1 check passed
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