summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/network.rst
diff options
context:
space:
mode:
authorJim Mussared <jim.mussared@gmail.com>2021-08-12 13:59:29 +1000
committerDamien George <damien@micropython.org>2021-08-13 22:53:29 +1000
commitc737cde9472741337be0c0a66e8e99695c6a9b14 (patch)
tree1d2d5a3d9b0580cc2d0a8abacbec98a55fb3d791 /docs/library/network.rst
parent218606351c6f9688a3f90dad791bcb2109adcf1b (diff)
downloadmicropython-c737cde9472741337be0c0a66e8e99695c6a9b14.tar.gz
micropython-c737cde9472741337be0c0a66e8e99695c6a9b14.zip
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/network.rst')
-rw-r--r--docs/library/network.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/library/network.rst b/docs/library/network.rst
index a20eb2ebf5..c188bb3135 100644
--- a/docs/library/network.rst
+++ b/docs/library/network.rst
@@ -9,7 +9,7 @@ This module provides network drivers and routing configuration. To use this
module, a MicroPython variant/build with network capabilities must be installed.
Network drivers for specific hardware are available within this module and are
used to configure hardware network interface(s). Network services provided
-by configured interfaces are then available for use via the :mod:`usocket`
+by configured interfaces are then available for use via the :mod:`socket`
module.
For example::
@@ -17,17 +17,17 @@ For example::
# connect/ show IP config a specific network interface
# see below for examples of specific drivers
import network
- import utime
+ import time
nic = network.Driver(...)
if not nic.isconnected():
nic.connect()
print("Waiting for connection...")
while not nic.isconnected():
- utime.sleep(1)
+ time.sleep(1)
print(nic.ifconfig())
- # now use usocket as usual
- import usocket as socket
+ # now use socket as usual
+ import socket as socket
addr = socket.getaddrinfo('micropython.org', 80)[0][-1]
s = socket.socket()
s.connect(addr)