From 052331168ed731ee73d280baf49fc710df376b1b Mon Sep 17 00:00:00 2001 From: "Earle F. Philhower, III" Date: Wed, 19 May 2021 18:03:12 -0700 Subject: [PATCH] Fix repo spelling issues (#152) --- .github/workflows/pull-request.yml | 3 +++ cores/rp2040/Arduino.h | 6 +++--- docs/eeprom.rst | 2 +- docs/fs.rst | 2 +- docs/i2s.rst | 2 +- libraries/Keyboard | 2 +- libraries/LittleFS/src/lfs.c | 2 +- libraries/SD/src/SD.h | 2 +- libraries/Servo/src/Servo.cpp | 4 ++-- libraries/Servo/src/Servo.h | 2 +- tools/README.md | 2 +- 11 files changed, 16 insertions(+), 13 deletions(-) diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml index d4e60f6..c9853fa 100644 --- a/.github/workflows/pull-request.yml +++ b/.github/workflows/pull-request.yml @@ -21,3 +21,6 @@ jobs: python-version: '3.x' - name: Run codespell uses: codespell-project/actions-codespell@master + with: + skip: ./pico-extras,./ArduinoCore-API,./libraries/SdFat,./libraries/Adafruit_TinyUSB_Arduino,./libraries/LittleFS/lib,./tools/pyserial,./pico-sdk,./.github,./docs/i2s.rst + ignore_words_list: ser,DOUT diff --git a/cores/rp2040/Arduino.h b/cores/rp2040/Arduino.h index 5ab8bb8..28f8248 100644 --- a/cores/rp2040/Arduino.h +++ b/cores/rp2040/Arduino.h @@ -24,7 +24,7 @@ #include #include #include -// Wacky deprecated AVR compatibilty functions +// Wacky deprecated AVR compatibility functions #include "stdlib_noniso.h" #include "api/ArduinoAPI.h" @@ -45,7 +45,7 @@ extern "C"{ #define clockCyclesToMicroseconds(a) ( (a) / clockCyclesPerMicrosecond() ) #define microsecondsToClockCycles(a) ( (a) * clockCyclesPerMicrosecond() ) -// Disable/reenable all interrupts. Safely handles nested disables +// Disable/re-enable all interrupts. Safely handles nested disables void interrupts(); void noInterrupts(); @@ -53,7 +53,7 @@ void noInterrupts(); void attachInterrupt(pin_size_t pin, voidFuncPtr callback, PinStatus mode); void detachInterrupt(pin_size_t pin); -// AVR compatibilty macros...naughty and accesses the HW directly +// AVR compatibility macros...naughty and accesses the HW directly #define digitalPinToPort(pin) (0) #define digitalPinToBitMask(pin) (1UL << (pin)) #define digitalPinToTimer(pin) (0) diff --git a/docs/eeprom.rst b/docs/eeprom.rst index 03d94aa..79b4ba3 100644 --- a/docs/eeprom.rst +++ b/docs/eeprom.rst @@ -4,7 +4,7 @@ EEPROM Library While the Raspberry Pi Pico RP2040 does not come with an EEPROM onboard, we simulate one by using a single 4K chunk of flash at the end of flash space. -**Note that this is a simulated EEPROM and will only support the numeber of +**Note that this is a simulated EEPROM and will only support the number of writes as the onboard flash chip, not the 100,000 or so of a real EEPROM.** Therefore, do not frequently update the EEPROM or you may prematurely wear out the flash. diff --git a/docs/fs.rst b/docs/fs.rst index d3491b8..6fb3767 100644 --- a/docs/fs.rst +++ b/docs/fs.rst @@ -3,7 +3,7 @@ File Systems The Arduino-Pico core supports using some of the onboard flash as a file system, useful for storing configuration data, output strings, logging, -and more. It also supports using SD cards as another (FAT32) filesytem, +and more. It also supports using SD cards as another (FAT32) filesystem, with an API that's compatible with the onboard flash file system. diff --git a/docs/i2s.rst b/docs/i2s.rst index 0aee15d..5c8fb36 100644 --- a/docs/i2s.rst +++ b/docs/i2s.rst @@ -47,7 +47,7 @@ the output will be changing. size_t write(uint8_t) ~~~~~~~~~~~~~~~~~~~~~ -Provided for compatibilty, but not very useful. Writes a sample from 0...255 +Provided for compatibility, but not very useful. Writes a sample from 0...255 to the I2S buffer. See ``write(int16_t)`` for a better one size_t write(const uint8_t \*buffer, size_t size) diff --git a/libraries/Keyboard b/libraries/Keyboard index e8c1394..dcc1a55 160000 --- a/libraries/Keyboard +++ b/libraries/Keyboard @@ -1 +1 @@ -Subproject commit e8c1394e693fbd43af900205ddbe195efa59244a +Subproject commit dcc1a556bffbb22a8f924b1e135394b99741f56d diff --git a/libraries/LittleFS/src/lfs.c b/libraries/LittleFS/src/lfs.c index 62022fc..63bebe1 100644 --- a/libraries/LittleFS/src/lfs.c +++ b/libraries/LittleFS/src/lfs.c @@ -1,4 +1,4 @@ -// Can't place library in ths src/ directory, Arduino will attempt to build the tests/etc. +// Can't place library in the src/ directory, Arduino will attempt to build the tests/etc. // Just have a stub here that redirects to the actual source file #pragma GCC diagnostic ignored "-Wmissing-field-initializers" diff --git a/libraries/SD/src/SD.h b/libraries/SD/src/SD.h index 5259d5d..52a9558 100644 --- a/libraries/SD/src/SD.h +++ b/libraries/SD/src/SD.h @@ -183,7 +183,7 @@ private: }; -// Expose FatStructs.h helpers for MSDOS date/time for use with dateTimeCallback +// Expose FatStructs.h helpers for MS-DOS date/time for use with dateTimeCallback static inline uint16_t FAT_DATE(uint16_t year, uint8_t month, uint8_t day) { return (year - 1980) << 9 | month << 5 | day; } diff --git a/libraries/Servo/src/Servo.cpp b/libraries/Servo/src/Servo.cpp index f90a688..f31045e 100644 --- a/libraries/Servo/src/Servo.cpp +++ b/libraries/Servo/src/Servo.cpp @@ -27,14 +27,14 @@ #include "servo.pio.h" static PIOProgram _servoPgm(&servo_program); -// similiar to map but will have increased accuracy that provides a more +// Similar to map but will have increased accuracy that provides a more // symmetrical api (call it and use result to reverse will provide the original value) int improved_map(int value, int minIn, int maxIn, int minOut, int maxOut) { const int rangeIn = maxIn - minIn; const int rangeOut = maxOut - minOut; const int deltaIn = value - minIn; - // fixed point math constants to improve accurancy of divide and rounding + // fixed point math constants to improve accuracy of divide and rounding constexpr int fixedHalfDecimal = 1; constexpr int fixedDecimal = fixedHalfDecimal * 2; diff --git a/libraries/Servo/src/Servo.h b/libraries/Servo/src/Servo.h index 547bf71..2ed9653 100644 --- a/libraries/Servo/src/Servo.h +++ b/libraries/Servo/src/Servo.h @@ -46,7 +46,7 @@ // The following values are in us (microseconds). // Since the defaults can be overwritten in the new attach() member function, // they were modified from the Arduino AVR defaults to be in the safe range -// of publically available specifications. While this implies that many 180° +// of publicly available specifications. While this implies that many 180° // servos do not operate the full 0° to 180° sweep using these, it also prevents // unsuspecting damage. For Arduino AVR, the same change is being discussed. #define DEFAULT_MIN_PULSE_WIDTH 1000 // uncalibrated default, the shortest duty cycle sent to a servo diff --git a/tools/README.md b/tools/README.md index b13ab2c..9f411c2 100644 --- a/tools/README.md +++ b/tools/README.md @@ -18,7 +18,7 @@ to get the board into update mode (1200bps connection). Very dumb `sed`-like tool used by the platform scripts to generate the linker `.ld` file (replacing the EEPROM location, FS sizes, etc.). Because we run on Windows, Mac, and Linux, need to provide this and not -rely on existance of `sed` command. +rely on existence of `sed` command. ## pyserial `git clone` of the PySerial Python3 library to be used by the IDE.