diff options
| author | Jim Mussared <jim.mussared@gmail.com> | 2021-08-12 13:59:29 +1000 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2021-08-13 22:53:29 +1000 |
| commit | c737cde9472741337be0c0a66e8e99695c6a9b14 (patch) | |
| tree | 1d2d5a3d9b0580cc2d0a8abacbec98a55fb3d791 /docs/library/bluetooth.rst | |
| parent | 218606351c6f9688a3f90dad791bcb2109adcf1b (diff) | |
docs: Replace ufoo with foo in all docs.
Anywhere a module is mentioned, use its "non-u" name for consistency.
The "import module" vs "import umodule" is something of a FAQ, and this
commit intends to help clear that up. As a first approximation MicroPython
is Python, and so imports should work the same as Python and use the same
name, to a first approximation. The u-version of a module is a detail that
can be learned later on, when the user wants to understand more and have
finer control over importing.
Existing Python code should just work, as much as it is possible to do that
within the constraints of embedded systems, and the MicroPython
documentation should match the idiomatic way to write Python code.
With universal weak links for modules (via MICROPY_MODULE_WEAK_LINKS) users
can consistently use "import foo" across all ports (with the exception of
the minimal ports). And the ability to override/extend via "foo.py"
continues to work well.
Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
Diffstat (limited to 'docs/library/bluetooth.rst')
| -rw-r--r-- | docs/library/bluetooth.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/library/bluetooth.rst b/docs/library/bluetooth.rst index 3d435a7be..f110bfb19 100644 --- a/docs/library/bluetooth.rst +++ b/docs/library/bluetooth.rst @@ -1,7 +1,7 @@ -:mod:`ubluetooth` --- low-level Bluetooth -========================================= +:mod:`bluetooth` --- low-level Bluetooth +======================================== -.. module:: ubluetooth +.. module:: bluetooth :synopsis: Low-level Bluetooth radio functionality This module provides an interface to a Bluetooth controller on a board. @@ -110,7 +110,7 @@ Event Handling **Note:** As an optimisation to prevent unnecessary allocations, the ``addr``, ``adv_data``, ``char_data``, ``notify_data``, and ``uuid`` entries in the - tuples are read-only memoryview instances pointing to ubluetooth's internal + tuples are read-only memoryview instances pointing to :mod:`bluetooth`'s internal ringbuffer, and are only valid during the invocation of the IRQ handler function. If your program needs to save one of these values to access after the IRQ handler has returned (e.g. by saving it in a class instance or global @@ -293,7 +293,7 @@ For the ``_IRQ_PASSKEY_ACTION`` event, the available actions are:: _PASSKEY_ACTION_NUMERIC_COMPARISON = const(4) In order to save space in the firmware, these constants are not included on the -:mod:`ubluetooth` module. Add the ones that you need from the list above to your +:mod:`bluetooth` module. Add the ones that you need from the list above to your program. |