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/wipy | |
| 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/wipy')
| -rw-r--r-- | docs/wipy/general.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/wipy/general.rst b/docs/wipy/general.rst index b1109c495..7f24435db 100644 --- a/docs/wipy/general.rst +++ b/docs/wipy/general.rst @@ -296,8 +296,8 @@ and put it in '/flash/cert/'. Then do:: ss = ssl.wrap_socket(s, cert_reqs=ssl.CERT_REQUIRED, ca_certs='/flash/cert/ca.pem') ss.connect(socket.getaddrinfo('cloud.blynk.cc', 8441)[0][-1]) -Incompatibilities in uhashlib module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Incompatibilities in hashlib module +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Due to hardware implementation details of the WiPy, data must be buffered before being digested, which would make it impossible to calculate the hash of big blocks of data that @@ -310,7 +310,7 @@ initial one) is a multiple of 4 bytes.** The last chunk may be of any length. Example:: - hash = uhashlib.sha1('abcd1234', 1001) # length of the initial piece is multiple of 4 bytes + hash = hashlib.sha1('abcd1234', 1001) # length of the initial piece is multiple of 4 bytes hash.update('1234') # also multiple of 4 bytes ... hash.update('12345') # last chunk may be of any length @@ -366,7 +366,7 @@ Adhoc VFS-like support ~~~~~~~~~~~~~~~~~~~~~~ WiPy doesn't implement full MicroPython VFS support, instead following -functions are defined in ``uos`` module: +functions are defined in ``os`` module: .. function:: mount(block_device, mount_point, \*, readonly=False) |