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/machine.SDCard.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/machine.SDCard.rst')
| -rw-r--r-- | docs/library/machine.SDCard.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/library/machine.SDCard.rst b/docs/library/machine.SDCard.rst index b1cf42ec0..96fb5b01c 100644 --- a/docs/library/machine.SDCard.rst +++ b/docs/library/machine.SDCard.rst @@ -27,10 +27,10 @@ vary from platform to platform. This class provides access to SD or MMC storage cards using either a dedicated SD/MMC interface hardware or through an SPI channel. - The class implements the block protocol defined by :class:`uos.AbstractBlockDev`. + The class implements the block protocol defined by :class:`os.AbstractBlockDev`. This allows the mounting of an SD card to be as simple as:: - uos.mount(machine.SDCard(), "/sd") + os.mount(machine.SDCard(), "/sd") The constructor takes the following parameters: |