Skip to content

Commit b1229ef

Browse files
committed
all: Fix spelling mistakes based on codespell check.
Signed-off-by: Damien George <[email protected]>
1 parent e160fe7 commit b1229ef

File tree

191 files changed

+282
-282
lines changed

Some content is hidden

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

191 files changed

+282
-282
lines changed

.github/ISSUE_TEMPLATE/security.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Security report
3-
about: Report a security issue or vunerability in MicroPython
3+
about: Report a security issue or vulnerability in MicroPython
44
title: ''
55
labels: security
66
assignees: ''

CODECONVENTIONS.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ Documentation conventions
255255
=========================
256256

257257
MicroPython generally follows CPython in documentation process and
258-
conventions. reStructuredText syntax is used for the documention.
258+
conventions. reStructuredText syntax is used for the documentation.
259259

260260
Specific conventions/suggestions:
261261

docs/develop/cmodules.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ A MicroPython user C module is a directory with the following files:
5353
``SRC_USERMOD_C`` or ``SRC_USERMOD_LIB_C`` variables. The former will be
5454
processed for ``MP_QSTR_`` and ``MP_REGISTER_MODULE`` definitions, the latter
5555
will not (e.g. helpers and library code that isn't MicroPython-specific).
56-
These paths should include your expaned copy of ``$(USERMOD_DIR)``, e.g.::
56+
These paths should include your expanded copy of ``$(USERMOD_DIR)``, e.g.::
5757

5858
SRC_USERMOD_C += $(EXAMPLE_MOD_DIR)/modexample.c
5959
SRC_USERMOD_LIB_C += $(EXAMPLE_MOD_DIR)/utils/algorithm.c

docs/esp32/tutorial/intro.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Requirements
1717
The first thing you need is a board with an ESP32 chip. The MicroPython
1818
software supports the ESP32 chip itself and any board should work. The main
1919
characteristic of a board is how the GPIO pins are connected to the outside
20-
world, and whether it includes a built-in USB-serial convertor to make the
20+
world, and whether it includes a built-in USB-serial converter to make the
2121
UART available to your PC.
2222

2323
Names of pins will be given in this tutorial using the chip names (eg GPIO2)
@@ -59,7 +59,7 @@ bootloader mode, and second you need to copy across the firmware. The exact
5959
procedure for these steps is highly dependent on the particular board and you will
6060
need to refer to its documentation for details.
6161

62-
Fortunately, most boards have a USB connector, a USB-serial convertor, and the DTR
62+
Fortunately, most boards have a USB connector, a USB-serial converter, and the DTR
6363
and RTS pins wired in a special way then deploying the firmware should be easy as
6464
all steps can be done automatically. Boards that have such features
6565
include the Adafruit Feather HUZZAH32, M5Stack, Wemos LOLIN32, and TinyPICO
@@ -104,7 +104,7 @@ Serial prompt
104104

105105
Once you have the firmware on the device you can access the REPL (Python prompt)
106106
over UART0 (GPIO1=TX, GPIO3=RX), which might be connected to a USB-serial
107-
convertor, depending on your board. The baudrate is 115200.
107+
converter, depending on your board. The baudrate is 115200.
108108

109109
From here you can now follow the ESP8266 tutorial, because these two Espressif chips
110110
are very similar when it comes to using MicroPython on them. The ESP8266 tutorial
@@ -124,7 +124,7 @@ after it, here are troubleshooting recommendations:
124124

125125
* The flashing instructions above use flashing speed of 460800 baud, which is
126126
good compromise between speed and stability. However, depending on your
127-
module/board, USB-UART convertor, cables, host OS, etc., the above baud
127+
module/board, USB-UART converter, cables, host OS, etc., the above baud
128128
rate may be too high and lead to errors. Try a more common 115200 baud
129129
rate instead in such cases.
130130

docs/esp8266/tutorial/intro.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The first thing you need is a board with an ESP8266 chip. The MicroPython
1818
software supports the ESP8266 chip itself and any board should work. The main
1919
characteristic of a board is how much flash it has, how the GPIO pins are
2020
connected to the outside world, and whether it includes a built-in USB-serial
21-
convertor to make the UART available to your PC.
21+
converter to make the UART available to your PC.
2222

2323
The minimum requirement for flash size is 1Mbyte. There is also a special
2424
build for boards with 512KB, but it is highly limited comparing to the
@@ -70,7 +70,7 @@ need to put your device in boot-loader mode, and second you need to copy across
7070
the firmware. The exact procedure for these steps is highly dependent on the
7171
particular board and you will need to refer to its documentation for details.
7272

73-
If you have a board that has a USB connector, a USB-serial convertor, and has
73+
If you have a board that has a USB connector, a USB-serial converter, and has
7474
the DTR and RTS pins wired in a special way then deploying the firmware should
7575
be easy as all steps can be done automatically. Boards that have such features
7676
include the Adafruit Feather HUZZAH and NodeMCU boards.
@@ -128,7 +128,7 @@ Serial prompt
128128

129129
Once you have the firmware on the device you can access the REPL (Python prompt)
130130
over UART0 (GPIO1=TX, GPIO3=RX), which might be connected to a USB-serial
131-
convertor, depending on your board. The baudrate is 115200. The next part of
131+
converter, depending on your board. The baudrate is 115200. The next part of
132132
the tutorial will discuss the prompt in more detail.
133133

134134
WiFi
@@ -137,7 +137,7 @@ WiFi
137137
After a fresh install and boot the device configures itself as a WiFi access
138138
point (AP) that you can connect to. The ESSID is of the form MicroPython-xxxxxx
139139
where the x's are replaced with part of the MAC address of your device (so will
140-
be the same everytime, and most likely different for all ESP8266 chips). The
140+
be the same every time, and most likely different for all ESP8266 chips). The
141141
password for the WiFi is micropythoN (note the upper-case N). Its IP address
142142
will be 192.168.4.1 once you connect to its network. WiFi configuration will
143143
be discussed in more detail later in the tutorial.
@@ -169,7 +169,7 @@ after it, here are troubleshooting recommendations:
169169

170170
* The flashing instructions above use flashing speed of 460800 baud, which is
171171
good compromise between speed and stability. However, depending on your
172-
module/board, USB-UART convertor, cables, host OS, etc., the above baud
172+
module/board, USB-UART converter, cables, host OS, etc., the above baud
173173
rate may be too high and lead to errors. Try a more common 115200 baud
174174
rate instead in such cases.
175175

docs/esp8266/tutorial/repl.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ REPL over the serial port
1313

1414
The REPL is always available on the UART0 serial peripheral, which is connected
1515
to the pins GPIO1 for TX and GPIO3 for RX. The baudrate of the REPL is 115200.
16-
If your board has a USB-serial convertor on it then you should be able to access
16+
If your board has a USB-serial converter on it then you should be able to access
1717
the REPL directly from your PC. Otherwise you will need to have a way of
1818
communicating with the UART.
1919

docs/library/array.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Classes
7575
Returns the string representation of the array, called as ``str(a)`` or ``repr(a)```
7676
(where ``a`` is an ``array``). Returns the string ``"array(<type>, [<elements>])"``,
7777
where ``<type>`` is the type code letter for the array and ``<elements>`` is a comma
78-
seperated list of the elements of the array.
78+
separated list of the elements of the array.
7979

8080
**Note:** ``__repr__`` cannot be called directly (``a.__repr__()`` fails) and
8181
is not present in ``__dict__``, however ``str(a)`` and ``repr(a)`` both work.

docs/library/bluetooth.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Configuration
4444
4545
Get or set configuration values of the BLE interface. To get a value the
4646
parameter name should be quoted as a string, and just one parameter is
47-
queried at a time. To set values use the keyword syntax, and one ore more
47+
queried at a time. To set values use the keyword syntax, and one or more
4848
parameter can be set at a time.
4949

5050
Currently supported values are:

docs/library/esp32.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ methods to enable over-the-air (OTA) updates.
126126
and an ``OSError(-261)`` is raised if called on firmware that doesn't have the
127127
feature enabled.
128128
It is OK to call ``mark_app_valid_cancel_rollback`` on every boot and it is not
129-
necessary when booting firmare that was loaded using esptool.
129+
necessary when booting firmware that was loaded using esptool.
130130

131131
Constants
132132
~~~~~~~~~

docs/library/machine.ADC.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
class ADC -- analog to digital conversion
55
=========================================
66

7-
The ADC class provides an interface to analog-to-digital convertors, and
7+
The ADC class provides an interface to analog-to-digital converters, and
88
represents a single endpoint that can sample a continuous voltage and
99
convert it to a discretised value.
1010

docs/library/machine.I2C.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ General Methods
9494
- *freq* is the SCL clock rate
9595

9696
In the case of hardware I2C the actual clock frequency may be lower than the
97-
requested frequency. This is dependant on the platform hardware. The actual
97+
requested frequency. This is dependent on the platform hardware. The actual
9898
rate may be determined by printing the I2C object.
9999

100100
.. method:: I2C.deinit()

docs/library/machine.I2S.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Constructor
103103
- ``ibuf`` specifies internal buffer length (bytes)
104104

105105
For all ports, DMA runs continuously in the background and allows user applications to perform other operations while
106-
sample data is transfered between the internal buffer and the I2S peripheral unit.
106+
sample data is transferred between the internal buffer and the I2S peripheral unit.
107107
Increasing the size of the internal buffer has the potential to increase the time that user applications can perform non-I2S operations
108108
before underflow (e.g. ``write`` method) or overflow (e.g. ``readinto`` method).
109109

docs/library/machine.SPI.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Methods
9898
specify them as a tuple of ``pins`` parameter.
9999

100100
In the case of hardware SPI the actual clock frequency may be lower than the
101-
requested baudrate. This is dependant on the platform hardware. The actual
101+
requested baudrate. This is dependent on the platform hardware. The actual
102102
rate may be determined by printing the SPI object.
103103

104104
.. method:: SPI.deinit()

docs/library/machine.Timer.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Methods
7373
- ``callback`` - The callable to call upon expiration of the timer period.
7474
The callback must take one argument, which is passed the Timer object.
7575
The ``callback`` argument shall be specified. Otherwise an exception
76-
will occurr upon timer expiration:
76+
will occur upon timer expiration:
7777
``TypeError: 'NoneType' object isn't callable``
7878

7979
.. method:: Timer.deinit()

docs/library/os.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Filesystem access
8686

8787
.. function:: statvfs(path)
8888

89-
Get the status of a fileystem.
89+
Get the status of a filesystem.
9090

9191
Returns a tuple with the filesystem information in the following order:
9292

docs/library/pyb.CAN.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ Methods
272272
- *fdf* for CAN FD controllers, if set to True, the frame will have an FD
273273
frame format, which supports data payloads up to 64 bytes.
274274
- *brs* for CAN FD controllers, if set to True, the bitrate switching mode
275-
is enabled, in which the data phase is transmitted at a differet bitrate.
275+
is enabled, in which the data phase is transmitted at a different bitrate.
276276
See :meth:`CAN.init` for the data bit timing configuration parameters.
277277

278278
If timeout is 0 the message is placed in a buffer in one of three hardware

docs/library/pyb.I2C.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Methods
9797
errors properly)
9898

9999
The actual clock frequency may be lower than the requested frequency.
100-
This is dependant on the platform hardware. The actual rate may be determined
100+
This is dependent on the platform hardware. The actual rate may be determined
101101
by printing the I2C object.
102102

103103
.. method:: I2C.is_ready(addr)

docs/library/sys.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Functions
4646
.. function:: settrace(tracefunc)
4747

4848
Enable tracing of bytecode execution. For details see the `CPython
49-
documentaion <https://docs.python.org/3/library/sys.html#sys.settrace>`_.
49+
documentation <https://docs.python.org/3/library/sys.html#sys.settrace>`_.
5050

5151
This function requires a custom MicroPython build as it is typically not
5252
present in pre-built firmware (due to it affecting performance). The relevant

docs/library/time.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -163,8 +163,8 @@ Functions
163163
However, values returned by `ticks_ms()`, etc. functions may wrap around, so
164164
directly using subtraction on them will produce incorrect result. That is why
165165
`ticks_diff()` is needed, it implements modular (or more specifically, ring)
166-
arithmetics to produce correct result even for wrap-around values (as long as they not
167-
too distant inbetween, see below). The function returns **signed** value in the range
166+
arithmetic to produce correct result even for wrap-around values (as long as they not
167+
too distant in between, see below). The function returns **signed** value in the range
168168
[*-TICKS_PERIOD/2* .. *TICKS_PERIOD/2-1*] (that's a typical range definition for
169169
two's-complement signed binary integers). If the result is negative, it means that
170170
*ticks1* occurred earlier in time than *ticks2*. Otherwise, it means that
@@ -183,7 +183,7 @@ Functions
183183
has passed. To avoid this mistake, just look at the clock regularly. Your application
184184
should do the same. "Too long sleep" metaphor also maps directly to application
185185
behaviour: don't let your application run any single task for too long. Run tasks
186-
in steps, and do time-keeping inbetween.
186+
in steps, and do time-keeping in between.
187187

188188
`ticks_diff()` is designed to accommodate various usage patterns, among them:
189189

docs/library/zephyr.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Functions
3232
* *CPU utilization is only printed if runtime statistics are configured via the ``CONFIG_THREAD_RUNTIME_STATS`` kconfig*
3333

3434
This function can only be accessed if ``CONFIG_THREAD_ANALYZER`` is configured for the port in ``zephyr/prj.conf``.
35-
For more infomation, see documentation for Zephyr `thread analyzer
35+
For more information, see documentation for Zephyr `thread analyzer
3636
<https://docs.zephyrproject.org/latest/guides/debug_tools/thread-analyzer.html#thread-analyzer>`_.
3737

3838
.. function:: shell_exec(cmd_in)

docs/pyboard/tutorial/usb_mouse.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ minus sign in front of the y-coordinate in the ``hid.send()`` line above.
120120
Restoring your pyboard to normal
121121
--------------------------------
122122

123-
If you leave your pyboard as-is, it'll behave as a mouse everytime you plug
123+
If you leave your pyboard as-is, it'll behave as a mouse every time you plug
124124
it in. You probably want to change it back to normal. To do this you need
125125
to first enter safe mode (see above), and then edit the ``boot.py`` file.
126126
In the ``boot.py`` file, comment out (put a # in front of) the line with the

docs/reference/asm_thumb2_compare.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Execute the next instruction if <condition> is true:
7575

7676
* ite(<condition>) If then else
7777

78-
If <condtion> is true, execute the next instruction, otherwise execute the
78+
If <condition> is true, execute the next instruction, otherwise execute the
7979
subsequent one. Thus:
8080

8181
::
@@ -86,5 +86,5 @@ subsequent one. Thus:
8686
mov(r0, 200) # runs if r0 != r1
8787
# execution continues here
8888

89-
This may be extended to control the execution of upto four subsequent instructions: it[x[y[z]]]
89+
This may be extended to control the execution of up to four subsequent instructions: it[x[y[z]]]
9090
where x,y,z=t/e; e.g. itt, itee, itete, ittte, itttt, iteee, etc.

docs/reference/constrained.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ were a string.
264264
265265
**Runtime compiler execution**
266266

267-
The Python funcitons `eval` and `exec` invoke the compiler at runtime, which
267+
The Python functions `eval` and `exec` invoke the compiler at runtime, which
268268
requires significant amounts of RAM. Note that the ``pickle`` library from
269269
`micropython-lib` employs `exec`. It may be more RAM efficient to use the
270270
`json` library for object serialisation.
@@ -403,7 +403,7 @@ Control of garbage collection
403403
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
404404

405405
A GC can be demanded at any time by issuing `gc.collect()`. It is advantageous
406-
to do this at intervals, firstly to pre-empt fragmentation and secondly for
406+
to do this at intervals, firstly to preempt fragmentation and secondly for
407407
performance. A GC can take several milliseconds but is quicker when there is
408408
little work to do (about 1ms on the Pyboard). An explicit call can minimise that
409409
delay while ensuring it occurs at points in the program when it is acceptable.

docs/rp2/general.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The peripherals include:
3030

3131
* 2 UARTs
3232
* 2 SPI controllers
33-
* 2 I2C contollers
33+
* 2 I2C controllers
3434
* 16 PWM channels
3535
* USB 1.1 controller
3636
* 8 PIO state machines

docs/rp2/quickref.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Programmable IO (PIO)
9696
---------------------
9797

9898
PIO is useful to build low-level IO interfaces from scratch. See the :mod:`rp2` module
99-
for detailed explaination of the assembly instructions.
99+
for detailed explanation of the assembly instructions.
100100

101101
Example using PIO to blink an LED at 1Hz::
102102

docs/zephyr/tutorial/repl.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ REPL over the serial port
1010

1111
The REPL is available on a UART serial peripheral specified for the board by
1212
the ``zephyr,console`` devicetree node. The baudrate of the REPL is 115200.
13-
If your board has a USB-serial convertor on it then you should be able to access
13+
If your board has a USB-serial converter on it then you should be able to access
1414
the REPL directly from your PC.
1515

1616
To access the prompt over USB-serial you will need to use a terminal emulator

drivers/cyw43/cywbt.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ STATIC int cywbt_hci_cmd_raw(size_t len, uint8_t *buf) {
6767
buf[i] = uart_rx_char(&mp_bluetooth_hci_uart_obj);
6868
}
6969

70-
// expect a comand complete event (event 0x0e)
70+
// expect a command complete event (event 0x0e)
7171
if (buf[0] != 0x04 || buf[1] != 0x0e) {
7272
printf("unknown response: %02x %02x %02x %02x\n", buf[0], buf[1], buf[2], buf[3]);
7373
return -1;

drivers/ninaw10/nina_wifi_drv.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ typedef enum {
105105
NINA_CMD_AP_GET_BSSID = 0x3C,
106106
NINA_CMD_AP_GET_CHANNEL = 0x3D,
107107

108-
// Disonnect/status commands.
108+
// Disconnect/status commands.
109109
NINA_CMD_DISCONNECT = 0x30,
110110
NINA_CMD_CONN_STATUS = 0x20,
111111
NINA_CMD_CONN_REASON = 0x1F,

examples/embedding/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ To build the example project, based on `main.c`, use:
2323

2424
$ make
2525

26-
That will create an exacutable called `embed` which you can run:
26+
That will create an executable called `embed` which you can run:
2727

2828
$ ./embed
2929

examples/hwapi/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ which would work from a board to board, from a system to another systems.
55
This is inherently a hard problem, because hardware is different from one
66
board type to another, and even from examplar of board to another. For
77
example, if your app requires an external LED, one user may connect it
8-
to one GPIO pin, while another user may find it much more convinient to
8+
to one GPIO pin, while another user may find it much more convenient to
99
use another pin. This of course applies to relays, buzzers, sensors, etc.
1010

1111
With complications above in mind, it's still possible to write portable

examples/hwapi/hwconfig_pyboard.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
from machine import Pin, Signal
22

3-
# Red LED on pin LED_RED also kown as A13
3+
# Red LED on pin LED_RED also known as A13
44
LED = Signal("LED_RED", Pin.OUT)
55

66
# Green LED on pin LED_GREEN also known as A14

examples/natmod/features1/features1.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ mp_obj_t mpy_init(mp_obj_fun_bc_t *self, size_t n_args, size_t n_kw, mp_obj_t *a
8888
// This must be first, it sets up the globals dict and other things
8989
MP_DYNRUNTIME_INIT_ENTRY
9090

91-
// Messages can be printed as usualy
91+
// Messages can be printed as usual
9292
mp_printf(&mp_plat_print, "initialising module self=%p\n", self);
9393

9494
// Make the functions available in the module's namespace

extmod/btstack/modbluetooth_btstack.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -883,7 +883,7 @@ int mp_bluetooth_gatts_register_service_begin(bool append) {
883883

884884
if (!append) {
885885
// This will reset the DB.
886-
// Becase the DB is statically allocated, there's no problem with just re-initing it.
886+
// Because the DB is statically allocated, there's no problem with just re-initing it.
887887
// Note this would be a memory leak if we enabled HAVE_MALLOC (there's no API to free the existing db).
888888
att_db_util_init();
889889

extmod/moduplatform.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
#include "py/misc.h" // For MP_STRINGIFY.
3030
#include "py/mpconfig.h"
3131

32-
// Preprocessor directives indentifying the platform.
32+
// Preprocessor directives identifying the platform.
3333
// The (u)platform module itself is guarded by MICROPY_PY_UPLATFORM, see the
3434
// .c file, but these are made available because they're generally usable.
3535
// TODO: Add more architectures, compilers and libraries.

0 commit comments

Comments
 (0)