Skip to content

Commit e04f050

Browse files
fix(spelling): Fix misspellings detected by codespell and enable it (#10232)
* fix(spelling): Fix misspellings detected by codespell and enable it * change(tools): Push generated binaries to PR --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 5ecda3a commit e04f050

File tree

41 files changed

+58
-58
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+58
-58
lines changed

.codespellrc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
[codespell]
22
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/spell-check/.codespellrc
33
# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
4-
ignore-words-list = ba,licence,ot,dout,als,exten,acount,totaly,pasttime
4+
ignore-words-list = ba,licence,ot,dout,als,exten
55
skip = ./.git,./.licenses,__pycache__,.clang-format,.codespellrc,.editorconfig,.flake8,.prettierignore,.yamllint.yml,.gitignore,boards.txt,platform.txt,programmers.txt
66
builtin = clear,informal,en-GB_to_en-US
77
check-filenames =
88
check-hidden =
9-
write-changes =

.pre-commit-config.yaml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
exclude: |
22
(?x)(
33
^\.github\/|
4-
^tests\/performance\/coremark\/.*\.[ch]$
4+
^tests\/performance\/coremark\/.*\.[ch]$|
5+
^tests\/performance\/superpi\/.*\.(cpp|h)$|
6+
LICENSE\.md$
57
)
68
79
default_language_version:
@@ -24,11 +26,10 @@ repos:
2426
- id: trailing-whitespace
2527
args: [--markdown-linebreak-ext=md]
2628
- repo: https://github.com/codespell-project/codespell
27-
rev: "v2.2.4"
29+
rev: "v2.3.0"
2830
hooks:
2931
- id: codespell
3032
exclude: ^.*\.(svd|SVD)$
31-
stages: [manual]
3233
- repo: https://github.com/pre-commit/mirrors-clang-format
3334
rev: "v18.1.3"
3435
hooks:

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
We as members, contributors, and leaders pledge to make participation in our
66
community a harassment-free experience for everyone, regardless of age, body
77
size, visible or invisible disability, ethnicity, sex characteristics, gender
8-
identity and expression, level of experience, education, socio-economic status,
8+
identity and expression, level of experience, education, socioeconomic status,
99
nationality, personal appearance, race, religion, or sexual identity
1010
and orientation.
1111

cores/esp32/Arduino.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ void initArduino(void);
179179
unsigned long pulseIn(uint8_t pin, uint8_t state, unsigned long timeout);
180180
unsigned long pulseInLong(uint8_t pin, uint8_t state, unsigned long timeout);
181181

182-
uint8_t shiftIn(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder);
182+
uint8_t shiftIn(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder); // codespell:ignore shiftin
183183
void shiftOut(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder, uint8_t val);
184184

185185
#ifdef __cplusplus

cores/esp32/HWCDC.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -443,7 +443,7 @@ size_t HWCDC::write(const uint8_t *buffer, size_t size) {
443443
if (connected) {
444444
usb_serial_jtag_ll_ena_intr_mask(USB_SERIAL_JTAG_INTR_SERIAL_IN_EMPTY);
445445
}
446-
// tracks CDC trasmission progress to avoid hanging if CDC is unplugged while still sending data
446+
// tracks CDC transmission progress to avoid hanging if CDC is unplugged while still sending data
447447
size_t last_toSend = to_send;
448448
uint32_t tries = tx_timeout_ms; // waits 1ms per sending data attempt, in case CDC is unplugged
449449
while (connected && to_send) {
@@ -479,7 +479,7 @@ size_t HWCDC::write(const uint8_t *buffer, size_t size) {
479479
}
480480
}
481481
}
482-
// CDC was diconnected while sending data ==> flush the TX buffer keeping the last data
482+
// CDC was disconnected while sending data ==> flush the TX buffer keeping the last data
483483
if (to_send && !usb_serial_jtag_ll_txfifo_writable()) {
484484
connected = false;
485485
flushTXBuffer(buffer + so_far, to_send);

cores/esp32/HardwareSerial.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ class HardwareSerial : public Stream {
228228

229229
// onReceive will setup a callback that will be called whenever an UART interruption occurs (UART_INTR_RXFIFO_FULL or UART_INTR_RXFIFO_TOUT)
230230
// UART_INTR_RXFIFO_FULL interrupt triggers at UART_FULL_THRESH_DEFAULT bytes received (defined as 120 bytes by default in IDF)
231-
// UART_INTR_RXFIFO_TOUT interrupt triggers at UART_TOUT_THRESH_DEFAULT symbols passed without any reception (defined as 10 symbos by default in IDF)
231+
// UART_INTR_RXFIFO_TOUT interrupt triggers at UART_TOUT_THRESH_DEFAULT symbols passed without any reception (defined as 10 symbols by default in IDF)
232232
// onlyOnTimeout parameter will define how onReceive will behave:
233233
// Default: true -- The callback will only be called when RX Timeout happens.
234234
// Whole stream of bytes will be ready for being read on the callback function at once.

cores/esp32/esp32-hal-uart.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ struct uart_struct_t {
4545
bool has_peek; // flag to indicate that there is a peek byte pending to be read
4646
uint8_t peek_byte; // peek byte that has been read but not consumed
4747
QueueHandle_t uart_event_queue; // export it by some uartGetEventQueue() function
48-
// configuration data:: Arduino API tipical data
48+
// configuration data:: Arduino API typical data
4949
int8_t _rxPin, _txPin, _ctsPin, _rtsPin; // UART GPIOs
5050
uint32_t _baudrate, _config; // UART baudrate and config
5151
// UART ESP32 specific data

cores/esp32/wiring_shift.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
#include "esp32-hal.h"
2121
#include "wiring_private.h"
2222

23-
uint8_t shiftIn(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder) {
23+
uint8_t shiftIn(uint8_t dataPin, uint8_t clockPin, uint8_t bitOrder) { // codespell:ignore shiftin
2424
uint8_t value = 0;
2525
uint8_t i;
2626

docs/en/api/gpio.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ One of the most used and versatile peripheral in a microcontroller is the GPIO.
99

1010
GPIO stands to General Purpose Input Output, and is responsible to control or read the state of a specific pin in the digital world. For example, this peripheral is widely used to create the LED blinking or to read a simple button.
1111

12-
.. note:: There are some GPIOs with special restrictions, and not all GPIOs are accessible through the developemnt board. For more information about it, see the corresponding board pin layout information.
12+
.. note:: There are some GPIOs with special restrictions, and not all GPIOs are accessible through the development board. For more information about it, see the corresponding board pin layout information.
1313

1414
GPIOs Modes
1515
***********

docs/en/tutorials/preferences.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -565,7 +565,7 @@ If you need to access a different namespace, close the one before opening the ot
565565
566566
currentNamespace.end(); // closes 'myNamespace'
567567
568-
currentNamespace.begin("myOtherNamespace", false); // opens a different Preferences namesspace.
568+
currentNamespace.begin("myOtherNamespace", false); // opens a different Preferences namespace.
569569
// do other stuff...
570570
571571
currentNamespace.end(); // closes 'myOtherNamespace'
@@ -644,7 +644,7 @@ Returning to the example above:
644644
645645
..
646646
647-
will assign to the variable ``dessert`` the String ``gravel`` if an error occurred, or the value stored against the key ``favourites`` if not.
647+
will assign to the variable ``dessert`` the String ``gravel`` if an error occurred, or the value stored against the key ``favorites`` if not.
648648

649649
If we predetermine a default value that is outside all legitimate values, we now have a way to test if an error actually occurred.
650650

0 commit comments

Comments
 (0)