Skip to content

Fix typos in documentation comments #31

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 29, 2022
Merged

Fix typos in documentation comments #31

merged 1 commit into from
Aug 29, 2022

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Aug 27, 2022

An update to the codespell tool used for spell checking the content of this repository caught some misspelled words in the documentation contents: misspelling of the word "calculates" caused a failure of the spell check run by the repository's continuous integration system:

https://github.com/arduino-libraries/Arduino_Portenta_OTA/runs/8047636055?check_suite_focus=true#step:4:17

Error: ./examples/OTA_Qspi_Flash/OTA_Qspi_Flash.ino:6: verifiy ==> verify
Error: ./examples/OTA_SD_Portenta/OTA_SD_Portenta.ino:6: verifiy ==> verify

I took this as an opportunity to do a comprehensive review and found a couple additional typos.

@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: documentation Related to documentation for the project labels Aug 27, 2022
@per1234 per1234 requested review from aentinger and pennam August 27, 2022 05:56
@per1234 per1234 self-assigned this Aug 27, 2022
@github-actions
Copy link

Memory usage change @ a84953c

Board flash % RAM for global variables %
arduino:mbed:envie_m7 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
arduino:mbed_nicla:nicla_vision 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
Click for full report table
Board examples/OTA_Qspi_Flash
flash
% examples/OTA_Qspi_Flash
RAM for global variables
% examples/OTA_SD_Portenta
flash
% examples/OTA_SD_Portenta
RAM for global variables
% examples/OTA_Usage_Portenta
flash
% examples/OTA_Usage_Portenta
RAM for global variables
%
arduino:mbed:envie_m7 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
arduino:mbed_nicla:nicla_vision 0 0.0 0 0.0 0 0.0 0 0.0
Click for full report CSV
Board,examples/OTA_Qspi_Flash<br>flash,%,examples/OTA_Qspi_Flash<br>RAM for global variables,%,examples/OTA_SD_Portenta<br>flash,%,examples/OTA_SD_Portenta<br>RAM for global variables,%,examples/OTA_Usage_Portenta<br>flash,%,examples/OTA_Usage_Portenta<br>RAM for global variables,%
arduino:mbed:envie_m7,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:mbed_nicla:nicla_vision,0,0.0,0,0.0,,,,,0,0.0,0,0.0

@aentinger aentinger merged commit b21c7cd into arduino-libraries:main Aug 29, 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.

2 participants