Skip to content

Commit ce166e6

Browse files
mcauserpfalcon
authored andcommitted
docs: Spelling mistakes
1 parent 3eb532e commit ce166e6

36 files changed

+60
-60
lines changed

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@ This can be achieved with:
3535
make MICROPY_PORT=<port_name> latexpdf
3636

3737
but require rather complete install of LaTeX with various extensions. On
38-
Debiab/Ubuntu, try (500MB+ download):
38+
Debian/Ubuntu, try (500MB+ download):
3939

4040
apt-get install texlive-latex-recommended texlive-latex-extra

docs/esp8266/general.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ For your convenience, some of technical specifications are provided below:
5252
external FlashROM, UART, deep sleep wake-up, etc.)
5353
* UART: One RX/TX UART (no hardware handshaking), one TX-only UART.
5454
* SPI: 2 SPI interfaces (one used for FlashROM).
55-
* I2C: No native extenal I2C (bitbang implementation available on any pins).
55+
* I2C: No native external I2C (bitbang implementation available on any pins).
5656
* I2S: 1.
5757
* Programming: using BootROM bootloader from UART. Due to external FlashROM
5858
and always-available BootROM bootloader, ESP8266 is not brickable.

docs/esp8266/tutorial/repl.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ WebREPL - a prompt over WiFi
3636
WebREPL allows you to use the Python prompt over WiFi, connecting through a
3737
browser. The latest versions of Firefox and Chrome are supported.
3838

39-
For your convinience, WebREPL client is hosted at
39+
For your convenience, WebREPL client is hosted at
4040
`<http://micropython.org/webrepl>`__ . Alternatively, you can install it
4141
locally from the the GitHub repository
4242
`<https://github.com/micropython/webrepl>`__ .

docs/library/builtins.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Builtin Functions
22
=================
33

4-
All builtin functions are described here. They are alse available via
4+
All builtin functions are described here. They are also available via
55
``builtins`` module.
66

77
.. function:: abs()

docs/library/esp.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Functions
1515
Get or set the sleep type.
1616

1717
If the ``sleep_type`` parameter is provided, sets the sleep type to its
18-
value. If the function is called wihout parameters, returns the current
18+
value. If the function is called without parameters, returns the current
1919
sleep type.
2020

2121
The possible sleep types are defined as constants:

docs/library/machine.Pin.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Methods
8484

8585
- ``None`` - no pull up or down resistor.
8686
- ``Pin.PULL_UP`` - pull up resistor enabled.
87-
- ``Pin.PULL_DOWN`` - pull down resitor enabled.
87+
- ``Pin.PULL_DOWN`` - pull down resistor enabled.
8888

8989
- ``drive`` can be one of:
9090

docs/library/machine.RTC.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Methods
3939

4040
.. method:: RTC.alarm(id, time, /*, repeat=False)
4141

42-
Set the RTC alarm. Time might be either a milllisecond value to program the alarm to
42+
Set the RTC alarm. Time might be either a millisecond value to program the alarm to
4343
current time + time_in_ms in the future, or a datetimetuple. If the time passed is in
4444
milliseconds, repeat can be set to ``True`` to make the alarm periodic.
4545

docs/library/machine.SPI.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Methods
4545
respectively.
4646
- ``bits`` is the width of each transfer, accepted values are 8, 16 and 32.
4747
- ``firstbit`` can be ``SPI.MSB`` only.
48-
- ``pins`` is an optional tupple with the pins to assign to the SPI bus.
48+
- ``pins`` is an optional tuple with the pins to assign to the SPI bus.
4949

5050
.. method:: SPI.deinit()
5151

docs/library/machine.Timer.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Methods
104104
If only a channel identifier passed, then a previously initialized channel
105105
object is returned (or ``None`` if there is no previous channel).
106106

107-
Othwerwise, a TimerChannel object is initialized and returned.
107+
Otherwise, a TimerChannel object is initialized and returned.
108108

109109
The operating mode is is the one configured to the Timer object that was used to
110110
create the channel.
@@ -152,7 +152,7 @@ Methods
152152

153153
.. method:: timerchannel.irq(\*, trigger, priority=1, handler=None)
154154

155-
The behavior of this callback is heaviliy dependent on the operating
155+
The behavior of this callback is heavily dependent on the operating
156156
mode of the timer channel:
157157

158158
- If mode is ``Timer.PERIODIC`` the callback is executed periodically

docs/library/machine.UART.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ Methods
167167
.. data:: UART.EVEN
168168
.. data:: UART.ODD
169169

170-
parity types (anlong with ``None``)
170+
parity types (along with ``None``)
171171

172172
.. data:: UART.RX_ANY
173173

docs/library/machine.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Power related functions
5757
Gates the clock to the CPU, useful to reduce power consumption at any time during
5858
short or long periods. Peripherals continue working and execution resumes as soon
5959
as any interrupt is triggered (on many ports this includes system timer
60-
interrupt occuring at regular intervals on the order of millisecond).
60+
interrupt occurring at regular intervals on the order of millisecond).
6161

6262
.. function:: sleep()
6363

@@ -96,7 +96,7 @@ Miscellaneous functions
9696

9797
.. function:: unique_id()
9898

99-
Returns a byte string with a unique idenifier of a board/SoC. It will vary
99+
Returns a byte string with a unique identifier of a board/SoC. It will vary
100100
from a board/SoC instance to another, if underlying hardware allows. Length
101101
varies by hardware (so use substring of a full value if you expect a short
102102
ID). In some MicroPython ports, ID corresponds to the network MAC address.

docs/library/network.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ For example::
237237
Get or set the PHY mode.
238238

239239
If the ``mode`` parameter is provided, sets the mode to its value. If
240-
the function is called wihout parameters, returns the current mode.
240+
the function is called without parameters, returns the current mode.
241241

242242
The possible modes are defined as constants:
243243
* ``MODE_11B`` -- IEEE 802.11b,
@@ -319,7 +319,7 @@ For example::
319319
* ``STAT_WRONG_PASSWORD`` -- failed due to incorrect password,
320320
* ``STAT_NO_AP_FOUND`` -- failed because no access point replied,
321321
* ``STAT_CONNECT_FAIL`` -- failed due to other problems,
322-
* ``STAT_GOT_IP`` -- connection susccessful.
322+
* ``STAT_GOT_IP`` -- connection successful.
323323

324324
.. method:: wlan.isconnected()
325325

@@ -329,7 +329,7 @@ For example::
329329

330330
.. method:: wlan.ifconfig([(ip, subnet, gateway, dns)])
331331

332-
Get/set IP-level network interface paremeters: IP address, subnet mask,
332+
Get/set IP-level network interface parameters: IP address, subnet mask,
333333
gateway and DNS server. When called with no arguments, this method returns
334334
a 4-tuple with the above information. To set the above values, pass a
335335
4-tuple with the required information. For example::
@@ -343,8 +343,8 @@ For example::
343343
with additional parameters beyond standard IP configuration (as dealt with by
344344
``wlan.ifconfig()``). These include network-specific and hardware-specific
345345
parameters. For setting parameters, keyword argument syntax should be used,
346-
multiple parameters can be set at once. For querying, paremeters name should
347-
be quoted as a string, and only one paramter can be queries at time::
346+
multiple parameters can be set at once. For querying, parameters name should
347+
be quoted as a string, and only one parameter can be queries at time::
348348

349349
# Set WiFi access point name (formally known as ESSID) and WiFi channel
350350
ap.config(essid='My AP', channel=11)
@@ -397,7 +397,7 @@ For example::
397397
.. note::
398398

399399
The ``WLAN`` constructor is special in the sense that if no arguments besides the id are given,
400-
it will return the already exisiting ``WLAN`` instance without re-configuring it. This is
400+
it will return the already existing ``WLAN`` instance without re-configuring it. This is
401401
because ``WLAN`` is a system feature of the WiPy. If the already existing instance is not
402402
initialized it will do the same as the other constructors an will initialize it with default
403403
values.

docs/library/pyb.ADC.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ class ADC -- analog to digital conversion
1313
adc = pyb.ADC(pin) # create an analog object from a pin
1414
val = adc.read() # read an analog value
1515
16-
adc = pyb.ADCAll(resolution) # creale an ADCAll object
16+
adc = pyb.ADCAll(resolution) # create an ADCAll object
1717
val = adc.read_channel(channel) # read the given channel
1818
val = adc.read_core_temp() # read MCU temperature
1919
val = adc.read_core_vbat() # read MCU VBAT

docs/library/pyb.DAC.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Methods
7979
.. method:: DAC.triangle(freq)
8080

8181
Generate a triangle wave. The value on the DAC output changes at
82-
the given frequency, and the frequence of the repeating triangle wave
82+
the given frequency, and the frequency of the repeating triangle wave
8383
itself is 2048 times smaller.
8484

8585
.. method:: DAC.write(value)

docs/library/pyb.ExtInt.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ class ExtInt -- configure I/O pins to interrupt on external events
77
There are a total of 22 interrupt lines. 16 of these can come from GPIO pins
88
and the remaining 6 are from internal sources.
99

10-
For lines 0 thru 15, a given line can map to the corresponding line from an
10+
For lines 0 through 15, a given line can map to the corresponding line from an
1111
arbitrary port. So line 0 can map to Px0 where x is A, B, C, ... and
1212
line 1 can map to Px1 where x is A, B, C, ... ::
1313

@@ -27,7 +27,7 @@ explanation, along with various techniques for debouncing.
2727
Trying to register 2 callbacks onto the same pin will throw an exception.
2828

2929
If pin is passed as an integer, then it is assumed to map to one of the
30-
internal interrupt sources, and must be in the range 16 thru 22.
30+
internal interrupt sources, and must be in the range 16 through 22.
3131

3232
All other pin objects go through the pin mapper to come up with one of the
3333
gpio pins. ::

docs/library/pyb.I2C.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Printing the i2c object gives you information about its configuration.
3939

4040
You can specify a timeout (in ms)::
4141

42-
i2c.send(b'123', timeout=2000) # timout after 2 seconds
42+
i2c.send(b'123', timeout=2000) # timeout after 2 seconds
4343

4444
A master must specify the recipient's address::
4545

docs/library/pyb.Pin.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ Constants
231231
class PinAF -- Pin Alternate Functions
232232
======================================
233233

234-
A Pin represents a physical pin on the microcprocessor. Each pin
234+
A Pin represents a physical pin on the microprocessor. Each pin
235235
can have a variety of functions (GPIO, I2C SDA, etc). Each PinAF
236236
object represents a particular function for a pin.
237237

@@ -240,7 +240,7 @@ Constants
240240
x3 = pyb.Pin.board.X3
241241
x3_af = x3.af_list()
242242
243-
x3_af will now contain an array of PinAF objects which are availble on
243+
x3_af will now contain an array of PinAF objects which are available on
244244
pin X3.
245245

246246
For the pyboard, x3_af would contain:

docs/library/pyb.RTC.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Methods
7373
value, which is an integer in the range [-511 : 512]. With one
7474
argument it sets the RTC calibration.
7575

76-
The RTC Smooth Calibration mechanism addjusts the RTC clock rate by
76+
The RTC Smooth Calibration mechanism adjusts the RTC clock rate by
7777
adding or subtracting the given number of ticks from the 32768 Hz
7878
clock over a 32 second period (corresponding to 2^20 clock ticks.)
7979
Each tick added will speed up the clock by 1 part in 2^20, or 0.954

docs/library/pyb.Timer.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Methods
7878
7979
Keyword arguments:
8080

81-
- ``freq`` --- specifies the periodic frequency of the timer. You migh also
81+
- ``freq`` --- specifies the periodic frequency of the timer. You might also
8282
view this as the frequency with which the timer goes through one complete cycle.
8383

8484
- ``prescaler`` [0-0xffff] - specifies the value to be loaded into the
@@ -97,7 +97,7 @@ Methods
9797

9898
- ``Timer.UP`` - configures the timer to count from 0 to ARR (default)
9999
- ``Timer.DOWN`` - configures the timer to count from ARR down to 0.
100-
- ``Timer.CENTER`` - confgures the timer to count from 0 to ARR and
100+
- ``Timer.CENTER`` - configures the timer to count from 0 to ARR and
101101
then back down to 0.
102102

103103
- ``div`` can be one of 1, 2, or 4. Divides the timer clock to determine
@@ -109,7 +109,7 @@ Methods
109109
transitions on complimentary channels (both channels will be inactive)
110110
for this time). ``deadtime`` may be an integer between 0 and 1008, with
111111
the following restrictions: 0-128 in steps of 1. 128-256 in steps of
112-
2, 256-512 in steps of 8, and 512-1008 in steps of 16. ``deadime``
112+
2, 256-512 in steps of 8, and 512-1008 in steps of 16. ``deadtime``
113113
measures ticks of ``source_freq`` divided by ``div`` clock ticks.
114114
``deadtime`` is only available on timers 1 and 8.
115115

@@ -141,7 +141,7 @@ Methods
141141
If only a channel number is passed, then a previously initialized channel
142142
object is returned (or ``None`` if there is no previous channel).
143143

144-
Othwerwise, a TimerChannel object is initialized and returned.
144+
Otherwise, a TimerChannel object is initialized and returned.
145145

146146
Each channel can be configured to perform pwm, output compare, or
147147
input capture. All channels share the same underlying timer, which means
@@ -183,7 +183,7 @@ Methods
183183
- ``polarity`` can be one of:
184184

185185
- ``Timer.HIGH`` - output is active high
186-
- ``Timer.LOW`` - output is acive low
186+
- ``Timer.LOW`` - output is active low
187187

188188
Optional keyword arguments for Timer.IC modes:
189189

docs/library/pyb.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Time related functions
4646
Returns the number of milliseconds which have elapsed since ``start``.
4747

4848
This function takes care of counter wrap, and always returns a positive
49-
number. This means it can be used to measure periods upto about 12.4 days.
49+
number. This means it can be used to measure periods up to about 12.4 days.
5050

5151
Example::
5252

@@ -59,7 +59,7 @@ Time related functions
5959
Returns the number of microseconds which have elapsed since ``start``.
6060

6161
This function takes care of counter wrap, and always returns a positive
62-
number. This means it can be used to measure periods upto about 17.8 minutes.
62+
number. This means it can be used to measure periods up to about 17.8 minutes.
6363

6464
Example::
6565

docs/library/ubinascii.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Functions
1717
.. admonition:: Difference to CPython
1818
:class: attention
1919

20-
If additional argument, `sep` is supplied, it is used as a seperator
20+
If additional argument, `sep` is supplied, it is used as a separator
2121
between hexadecimal values.
2222

2323
.. function:: unhexlify(data)

docs/library/ucollections.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ Classes
1313
.. function:: namedtuple(name, fields)
1414

1515
This is factory function to create a new namedtuple type with a specific
16-
name and set of fields. A namedtyple is a subclass of tuple which allows
16+
name and set of fields. A namedtuple is a subclass of tuple which allows
1717
to access its fields not just by numeric index, but also with an attribute
1818
access syntax using symbolic field names. Fields is a sequence of strings
19-
specifying field names. For compatibily with CPython it can also be a
19+
specifying field names. For compatibility with CPython it can also be a
2020
a string with space-separated field named (but this is less efficient).
2121
Example of use::
2222

docs/library/uctypes.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Module contents
118118

119119
.. data:: BIG_ENDIAN
120120

121-
Layour type for a big-endian packed structure.
121+
Layout type for a big-endian packed structure.
122122

123123
.. data:: NATIVE
124124

@@ -184,7 +184,7 @@ Subscripting a pointer with other integer values but 0 are supported too,
184184
with the same semantics as in C.
185185

186186
Summing up, accessing structure fields generally follows C syntax,
187-
except for pointer derefence, when you need to use ``[0]`` operator
187+
except for pointer dereference, when you need to use ``[0]`` operator
188188
instead of ``*``.
189189

190190
Limitations

docs/library/uhashlib.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
This module implements binary data hashing algorithms. Currently, it
1010
implements SHA256 algorithm. Choosing SHA256 was a deliberate choice,
1111
as a modern, cryptographically secure algorithm. This means that a
12-
single algorithm can cover both usecases of "any hash algorithm" and
12+
single algorithm can cover both use cases of "any hash algorithm" and
1313
security-related usage, and thus save space omitting legacy algorithms
1414
like MD5 or SHA1.
1515

@@ -53,7 +53,7 @@ Constructors
5353

5454
Example::
5555
56-
hash = uhashlib.sha1('abcd1234', 1001) # lenght of the initial piece is multiple of 4 bytes
56+
hash = uhashlib.sha1('abcd1234', 1001) # length of the initial piece is multiple of 4 bytes
5757
hash.update('1234') # also multiple of 4 bytes
5858
...
5959
hash.update('12345') # last chunk may be of any length
@@ -68,7 +68,7 @@ Methods
6868

6969
.. method:: hash.digest()
7070

71-
Return hash for all data passed thru hash, as a bytes object. After this
71+
Return hash for all data passed through hash, as a bytes object. After this
7272
method is called, more data cannot be fed into hash any longer.
7373

7474
.. only:: port_wipy

docs/library/uio.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Functions
1212

1313
.. function:: open(name, mode='r', **kwargs)
1414

15-
Open a file. Builtin ``open()`` function is alised to this function.
15+
Open a file. Builtin ``open()`` function is aliased to this function.
1616
All ports (which provide access to file system) are required to support
1717
`mode` parameter, but support for other arguments vary by port.
1818

docs/library/uos.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Functions
8181

8282
.. function:: unmount(path)
8383

84-
Unmounts a prevoulsy mounted block device from the given path.
84+
Unmounts a previously mounted block device from the given path.
8585

8686
.. function:: mkfs(block_device or path)
8787

docs/library/utime.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ Functions
117117
.. function:: time()
118118

119119
Returns the number of seconds, as an integer, since the Epoch, assuming that underlying
120-
RTC is set and maintained as decsribed above. If an RTC is not set, this function returns
120+
RTC is set and maintained as described above. If an RTC is not set, this function returns
121121
number of seconds since a port-specific reference point in time (for embedded boards without
122122
a battery-backed RTC, usually since power up or reset). If you want to develop portable
123123
MicroPython application, you should not rely on this function to provide higher than second

0 commit comments

Comments
 (0)