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/pyb.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/pyb.rst')
| -rw-r--r-- | docs/library/pyb.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/library/pyb.rst b/docs/library/pyb.rst index 321be3c52..880d68c53 100644 --- a/docs/library/pyb.rst +++ b/docs/library/pyb.rst @@ -213,11 +213,11 @@ Miscellaneous functions .. function:: mount(device, mountpoint, *, readonly=False, mkfs=False) .. note:: This function is deprecated. Mounting and unmounting devices should - be performed by :meth:`uos.mount` and :meth:`uos.umount` instead. + be performed by :meth:`os.mount` and :meth:`os.umount` instead. Mount a block device and make it available as part of the filesystem. ``device`` must be an object that provides the block protocol. (The - following is also deprecated. See :class:`uos.AbstractBlockDev` for the + following is also deprecated. See :class:`os.AbstractBlockDev` for the correct way to create a block device.) - ``readblocks(self, blocknum, buf)`` |