diff options
Diffstat (limited to 'docs/library')
| -rw-r--r-- | docs/library/array.rst | 2 | ||||
| -rw-r--r-- | docs/library/bluetooth.rst | 2 | ||||
| -rw-r--r-- | docs/library/esp32.rst | 2 | ||||
| -rw-r--r-- | docs/library/machine.ADC.rst | 2 | ||||
| -rw-r--r-- | docs/library/machine.I2C.rst | 2 | ||||
| -rw-r--r-- | docs/library/machine.I2S.rst | 2 | ||||
| -rw-r--r-- | docs/library/machine.SPI.rst | 2 | ||||
| -rw-r--r-- | docs/library/machine.Timer.rst | 2 | ||||
| -rw-r--r-- | docs/library/os.rst | 2 | ||||
| -rw-r--r-- | docs/library/pyb.CAN.rst | 2 | ||||
| -rw-r--r-- | docs/library/pyb.I2C.rst | 2 | ||||
| -rw-r--r-- | docs/library/sys.rst | 2 | ||||
| -rw-r--r-- | docs/library/time.rst | 6 | ||||
| -rw-r--r-- | docs/library/zephyr.rst | 2 |
14 files changed, 16 insertions, 16 deletions
diff --git a/docs/library/array.rst b/docs/library/array.rst index f94cece2b..f417a7046 100644 --- a/docs/library/array.rst +++ b/docs/library/array.rst @@ -75,7 +75,7 @@ Classes Returns the string representation of the array, called as ``str(a)`` or ``repr(a)``` (where ``a`` is an ``array``). Returns the string ``"array(<type>, [<elements>])"``, where ``<type>`` is the type code letter for the array and ``<elements>`` is a comma - seperated list of the elements of the array. + separated list of the elements of the array. **Note:** ``__repr__`` cannot be called directly (``a.__repr__()`` fails) and is not present in ``__dict__``, however ``str(a)`` and ``repr(a)`` both work. diff --git a/docs/library/bluetooth.rst b/docs/library/bluetooth.rst index dd0f5ffd6..78cb4cc28 100644 --- a/docs/library/bluetooth.rst +++ b/docs/library/bluetooth.rst @@ -44,7 +44,7 @@ Configuration Get or set configuration values of the BLE interface. To get a value the parameter name should be quoted as a string, and just one parameter is - queried at a time. To set values use the keyword syntax, and one ore more + queried at a time. To set values use the keyword syntax, and one or more parameter can be set at a time. Currently supported values are: diff --git a/docs/library/esp32.rst b/docs/library/esp32.rst index f0f0c8ef1..12d089021 100644 --- a/docs/library/esp32.rst +++ b/docs/library/esp32.rst @@ -126,7 +126,7 @@ methods to enable over-the-air (OTA) updates. and an ``OSError(-261)`` is raised if called on firmware that doesn't have the feature enabled. It is OK to call ``mark_app_valid_cancel_rollback`` on every boot and it is not - necessary when booting firmare that was loaded using esptool. + necessary when booting firmware that was loaded using esptool. Constants ~~~~~~~~~ diff --git a/docs/library/machine.ADC.rst b/docs/library/machine.ADC.rst index eb538a442..65225ea87 100644 --- a/docs/library/machine.ADC.rst +++ b/docs/library/machine.ADC.rst @@ -4,7 +4,7 @@ class ADC -- analog to digital conversion ========================================= -The ADC class provides an interface to analog-to-digital convertors, and +The ADC class provides an interface to analog-to-digital converters, and represents a single endpoint that can sample a continuous voltage and convert it to a discretised value. diff --git a/docs/library/machine.I2C.rst b/docs/library/machine.I2C.rst index bfc9f7ebc..635d58734 100644 --- a/docs/library/machine.I2C.rst +++ b/docs/library/machine.I2C.rst @@ -94,7 +94,7 @@ General Methods - *freq* is the SCL clock rate In the case of hardware I2C the actual clock frequency may be lower than the - requested frequency. This is dependant on the platform hardware. The actual + requested frequency. This is dependent on the platform hardware. The actual rate may be determined by printing the I2C object. .. method:: I2C.deinit() diff --git a/docs/library/machine.I2S.rst b/docs/library/machine.I2S.rst index b602ac650..2244ef420 100644 --- a/docs/library/machine.I2S.rst +++ b/docs/library/machine.I2S.rst @@ -103,7 +103,7 @@ Constructor - ``ibuf`` specifies internal buffer length (bytes) For all ports, DMA runs continuously in the background and allows user applications to perform other operations while - sample data is transfered between the internal buffer and the I2S peripheral unit. + sample data is transferred between the internal buffer and the I2S peripheral unit. Increasing the size of the internal buffer has the potential to increase the time that user applications can perform non-I2S operations before underflow (e.g. ``write`` method) or overflow (e.g. ``readinto`` method). diff --git a/docs/library/machine.SPI.rst b/docs/library/machine.SPI.rst index 7b0e8cf40..7c3c4b583 100644 --- a/docs/library/machine.SPI.rst +++ b/docs/library/machine.SPI.rst @@ -98,7 +98,7 @@ Methods specify them as a tuple of ``pins`` parameter. In the case of hardware SPI the actual clock frequency may be lower than the - requested baudrate. This is dependant on the platform hardware. The actual + requested baudrate. This is dependent on the platform hardware. The actual rate may be determined by printing the SPI object. .. method:: SPI.deinit() diff --git a/docs/library/machine.Timer.rst b/docs/library/machine.Timer.rst index 48c023a11..44e659408 100644 --- a/docs/library/machine.Timer.rst +++ b/docs/library/machine.Timer.rst @@ -73,7 +73,7 @@ Methods - ``callback`` - The callable to call upon expiration of the timer period. The callback must take one argument, which is passed the Timer object. The ``callback`` argument shall be specified. Otherwise an exception - will occurr upon timer expiration: + will occur upon timer expiration: ``TypeError: 'NoneType' object isn't callable`` .. method:: Timer.deinit() diff --git a/docs/library/os.rst b/docs/library/os.rst index 19652ee2b..27a7d2d44 100644 --- a/docs/library/os.rst +++ b/docs/library/os.rst @@ -86,7 +86,7 @@ Filesystem access .. function:: statvfs(path) - Get the status of a fileystem. + Get the status of a filesystem. Returns a tuple with the filesystem information in the following order: diff --git a/docs/library/pyb.CAN.rst b/docs/library/pyb.CAN.rst index 5ca00b65e..57a85d54b 100644 --- a/docs/library/pyb.CAN.rst +++ b/docs/library/pyb.CAN.rst @@ -272,7 +272,7 @@ Methods - *fdf* for CAN FD controllers, if set to True, the frame will have an FD frame format, which supports data payloads up to 64 bytes. - *brs* for CAN FD controllers, if set to True, the bitrate switching mode - is enabled, in which the data phase is transmitted at a differet bitrate. + is enabled, in which the data phase is transmitted at a different bitrate. See :meth:`CAN.init` for the data bit timing configuration parameters. If timeout is 0 the message is placed in a buffer in one of three hardware diff --git a/docs/library/pyb.I2C.rst b/docs/library/pyb.I2C.rst index 2c526854a..71d043aa6 100644 --- a/docs/library/pyb.I2C.rst +++ b/docs/library/pyb.I2C.rst @@ -97,7 +97,7 @@ Methods errors properly) The actual clock frequency may be lower than the requested frequency. - This is dependant on the platform hardware. The actual rate may be determined + This is dependent on the platform hardware. The actual rate may be determined by printing the I2C object. .. method:: I2C.is_ready(addr) diff --git a/docs/library/sys.rst b/docs/library/sys.rst index 3efdce964..c8eb4b5c5 100644 --- a/docs/library/sys.rst +++ b/docs/library/sys.rst @@ -46,7 +46,7 @@ Functions .. function:: settrace(tracefunc) Enable tracing of bytecode execution. For details see the `CPython - documentaion <https://docs.python.org/3/library/sys.html#sys.settrace>`_. + documentation <https://docs.python.org/3/library/sys.html#sys.settrace>`_. This function requires a custom MicroPython build as it is typically not present in pre-built firmware (due to it affecting performance). The relevant diff --git a/docs/library/time.rst b/docs/library/time.rst index 3ab5caf24..8c1c1d4d6 100644 --- a/docs/library/time.rst +++ b/docs/library/time.rst @@ -163,8 +163,8 @@ Functions However, values returned by `ticks_ms()`, etc. functions may wrap around, so directly using subtraction on them will produce incorrect result. That is why `ticks_diff()` is needed, it implements modular (or more specifically, ring) - arithmetics to produce correct result even for wrap-around values (as long as they not - too distant inbetween, see below). The function returns **signed** value in the range + arithmetic to produce correct result even for wrap-around values (as long as they not + too distant in between, see below). The function returns **signed** value in the range [*-TICKS_PERIOD/2* .. *TICKS_PERIOD/2-1*] (that's a typical range definition for two's-complement signed binary integers). If the result is negative, it means that *ticks1* occurred earlier in time than *ticks2*. Otherwise, it means that @@ -183,7 +183,7 @@ Functions has passed. To avoid this mistake, just look at the clock regularly. Your application should do the same. "Too long sleep" metaphor also maps directly to application behaviour: don't let your application run any single task for too long. Run tasks - in steps, and do time-keeping inbetween. + in steps, and do time-keeping in between. `ticks_diff()` is designed to accommodate various usage patterns, among them: diff --git a/docs/library/zephyr.rst b/docs/library/zephyr.rst index da3d14a09..10676d908 100644 --- a/docs/library/zephyr.rst +++ b/docs/library/zephyr.rst @@ -32,7 +32,7 @@ Functions * *CPU utilization is only printed if runtime statistics are configured via the ``CONFIG_THREAD_RUNTIME_STATS`` kconfig* This function can only be accessed if ``CONFIG_THREAD_ANALYZER`` is configured for the port in ``zephyr/prj.conf``. - For more infomation, see documentation for Zephyr `thread analyzer + For more information, see documentation for Zephyr `thread analyzer <https://docs.zephyrproject.org/latest/guides/debug_tools/thread-analyzer.html#thread-analyzer>`_. .. function:: shell_exec(cmd_in) |