From f98831fce2f9e8a8ea906078e8d187316beda625 Mon Sep 17 00:00:00 2001 From: Jim Mussared Date: Thu, 12 Aug 2021 13:56:13 +1000 Subject: [PATCH 1/4] docs: Rename ufoo.rst to foo.rst. This is a simple rename of the files, no content changes (other than updating index.rst to use the new paths) Signed-off-by: Jim Mussared --- docs/library/{uarray.rst => array.rst} | 0 docs/library/{ubinascii.rst => binascii.rst} | 0 .../library/{ubluetooth.rst => bluetooth.rst} | 0 .../{ucollections.rst => collections.rst} | 0 .../library/{ucryptolib.rst => cryptolib.rst} | 0 docs/library/{uerrno.rst => errno.rst} | 0 docs/library/{uhashlib.rst => hashlib.rst} | 0 docs/library/{uheapq.rst => heapq.rst} | 0 docs/library/index.rst | 38 +++++++++---------- docs/library/{uio.rst => io.rst} | 0 docs/library/{ujson.rst => json.rst} | 0 docs/library/{uos.rst => os.rst} | 0 docs/library/{ure.rst => re.rst} | 0 docs/library/{uselect.rst => select.rst} | 0 docs/library/{usocket.rst => socket.rst} | 0 docs/library/{ussl.rst => ssl.rst} | 0 docs/library/{ustruct.rst => struct.rst} | 0 docs/library/{usys.rst => sys.rst} | 0 docs/library/{utime.rst => time.rst} | 0 docs/library/{uzlib.rst => zlib.rst} | 0 20 files changed, 19 insertions(+), 19 deletions(-) rename docs/library/{uarray.rst => array.rst} (100%) rename docs/library/{ubinascii.rst => binascii.rst} (100%) rename docs/library/{ubluetooth.rst => bluetooth.rst} (100%) rename docs/library/{ucollections.rst => collections.rst} (100%) rename docs/library/{ucryptolib.rst => cryptolib.rst} (100%) rename docs/library/{uerrno.rst => errno.rst} (100%) rename docs/library/{uhashlib.rst => hashlib.rst} (100%) rename docs/library/{uheapq.rst => heapq.rst} (100%) rename docs/library/{uio.rst => io.rst} (100%) rename docs/library/{ujson.rst => json.rst} (100%) rename docs/library/{uos.rst => os.rst} (100%) rename docs/library/{ure.rst => re.rst} (100%) rename docs/library/{uselect.rst => select.rst} (100%) rename docs/library/{usocket.rst => socket.rst} (100%) rename docs/library/{ussl.rst => ssl.rst} (100%) rename docs/library/{ustruct.rst => struct.rst} (100%) rename docs/library/{usys.rst => sys.rst} (100%) rename docs/library/{utime.rst => time.rst} (100%) rename docs/library/{uzlib.rst => zlib.rst} (100%) diff --git a/docs/library/uarray.rst b/docs/library/array.rst similarity index 100% rename from docs/library/uarray.rst rename to docs/library/array.rst diff --git a/docs/library/ubinascii.rst b/docs/library/binascii.rst similarity index 100% rename from docs/library/ubinascii.rst rename to docs/library/binascii.rst diff --git a/docs/library/ubluetooth.rst b/docs/library/bluetooth.rst similarity index 100% rename from docs/library/ubluetooth.rst rename to docs/library/bluetooth.rst diff --git a/docs/library/ucollections.rst b/docs/library/collections.rst similarity index 100% rename from docs/library/ucollections.rst rename to docs/library/collections.rst diff --git a/docs/library/ucryptolib.rst b/docs/library/cryptolib.rst similarity index 100% rename from docs/library/ucryptolib.rst rename to docs/library/cryptolib.rst diff --git a/docs/library/uerrno.rst b/docs/library/errno.rst similarity index 100% rename from docs/library/uerrno.rst rename to docs/library/errno.rst diff --git a/docs/library/uhashlib.rst b/docs/library/hashlib.rst similarity index 100% rename from docs/library/uhashlib.rst rename to docs/library/hashlib.rst diff --git a/docs/library/uheapq.rst b/docs/library/heapq.rst similarity index 100% rename from docs/library/uheapq.rst rename to docs/library/heapq.rst diff --git a/docs/library/index.rst b/docs/library/index.rst index 2536e8dc96d04..2840688b4879a 100644 --- a/docs/library/index.rst +++ b/docs/library/index.rst @@ -73,28 +73,28 @@ it will fallback to loading the built-in ``ujson`` module. .. toctree:: :maxdepth: 1 + array.rst + binascii.rst builtins.rst cmath.rst + collections.rst + errno.rst gc.rst + hashlib.rst + heapq.rst + io.rst + json.rst math.rst - uarray.rst + os.rst + re.rst + select.rst + socket.rst + ssl.rst + struct.rst + sys.rst + time.rst uasyncio.rst - ubinascii.rst - ucollections.rst - uerrno.rst - uhashlib.rst - uheapq.rst - uio.rst - ujson.rst - uos.rst - ure.rst - uselect.rst - usocket.rst - ussl.rst - ustruct.rst - usys.rst - utime.rst - uzlib.rst + zlib.rst _thread.rst @@ -107,13 +107,13 @@ the following libraries. .. toctree:: :maxdepth: 1 + bluetooth.rst btree.rst + cryptolib.rst framebuf.rst machine.rst micropython.rst network.rst - ubluetooth.rst - ucryptolib.rst uctypes.rst diff --git a/docs/library/uio.rst b/docs/library/io.rst similarity index 100% rename from docs/library/uio.rst rename to docs/library/io.rst diff --git a/docs/library/ujson.rst b/docs/library/json.rst similarity index 100% rename from docs/library/ujson.rst rename to docs/library/json.rst diff --git a/docs/library/uos.rst b/docs/library/os.rst similarity index 100% rename from docs/library/uos.rst rename to docs/library/os.rst diff --git a/docs/library/ure.rst b/docs/library/re.rst similarity index 100% rename from docs/library/ure.rst rename to docs/library/re.rst diff --git a/docs/library/uselect.rst b/docs/library/select.rst similarity index 100% rename from docs/library/uselect.rst rename to docs/library/select.rst diff --git a/docs/library/usocket.rst b/docs/library/socket.rst similarity index 100% rename from docs/library/usocket.rst rename to docs/library/socket.rst diff --git a/docs/library/ussl.rst b/docs/library/ssl.rst similarity index 100% rename from docs/library/ussl.rst rename to docs/library/ssl.rst diff --git a/docs/library/ustruct.rst b/docs/library/struct.rst similarity index 100% rename from docs/library/ustruct.rst rename to docs/library/struct.rst diff --git a/docs/library/usys.rst b/docs/library/sys.rst similarity index 100% rename from docs/library/usys.rst rename to docs/library/sys.rst diff --git a/docs/library/utime.rst b/docs/library/time.rst similarity index 100% rename from docs/library/utime.rst rename to docs/library/time.rst diff --git a/docs/library/uzlib.rst b/docs/library/zlib.rst similarity index 100% rename from docs/library/uzlib.rst rename to docs/library/zlib.rst From dccc030ab4fad31199009a0ed2f445362921d409 Mon Sep 17 00:00:00 2001 From: Jim Mussared Date: Thu, 12 Aug 2021 13:59:29 +1000 Subject: [PATCH 2/4] docs: Replace ufoo with foo in all docs. Anywhere a module is mentioned, use it's "non-u" name for consistency. Signed-off-by: Jim Mussared --- docs/develop/library.rst | 2 +- docs/develop/porting.rst | 4 +-- docs/esp32/quickref.rst | 12 ++++----- docs/esp8266/general.rst | 4 +-- docs/esp8266/quickref.rst | 12 ++++----- docs/library/array.rst | 4 +-- docs/library/binascii.rst | 4 +-- docs/library/bluetooth.rst | 8 +++--- docs/library/btree.rst | 2 +- docs/library/collections.rst | 8 +++--- docs/library/cryptolib.rst | 10 ++++---- docs/library/errno.rst | 10 ++++---- docs/library/esp32.rst | 2 +- docs/library/hashlib.rst | 12 ++++----- docs/library/heapq.rst | 4 +-- docs/library/index.rst | 4 +-- docs/library/io.rst | 4 +-- docs/library/json.rst | 4 +-- docs/library/machine.SDCard.rst | 4 +-- docs/library/network.WLAN.rst | 2 +- docs/library/network.rst | 10 ++++---- docs/library/os.rst | 12 ++++----- docs/library/pyb.Flash.rst | 2 +- docs/library/pyb.rst | 4 +-- docs/library/re.rst | 12 ++++----- docs/library/rp2.Flash.rst | 2 +- docs/library/select.rst | 16 ++++++------ docs/library/socket.rst | 44 ++++++++++++++++----------------- docs/library/ssl.rst | 18 +++++++------- docs/library/struct.rst | 4 +-- docs/library/sys.rst | 12 ++++----- docs/library/time.rst | 8 +++--- docs/library/uctypes.rst | 2 +- docs/library/zlib.rst | 4 +-- docs/pyboard/quickref.rst | 2 +- docs/reference/constrained.rst | 6 ++--- docs/reference/filesystem.rst | 12 ++++----- docs/reference/glossary.rst | 2 +- docs/reference/speed_python.rst | 6 ++--- docs/rp2/quickref.rst | 2 +- docs/wipy/general.rst | 6 ++--- 41 files changed, 151 insertions(+), 151 deletions(-) diff --git a/docs/develop/library.rst b/docs/develop/library.rst index bebddcc8a3605..47ea2dc8d2431 100644 --- a/docs/develop/library.rst +++ b/docs/develop/library.rst @@ -34,7 +34,7 @@ An example is the ``gc`` module discussed in :ref:`memorymanagement`. >>> gc.enable() >>> -MicroPython has several other builtin standard/core modules like ``io``, ``uarray`` etc. +MicroPython has several other builtin standard/core modules like ``io``, ``array`` etc. Adding a new core module involves several modifications. First, create the ``C`` file in the ``py/`` directory. In this example we are adding a diff --git a/docs/develop/porting.rst b/docs/develop/porting.rst index 08f3557f1835d..549227d76267c 100644 --- a/docs/develop/porting.rst +++ b/docs/develop/porting.rst @@ -245,8 +245,8 @@ That should give a MicroPython REPL. You can then run commands like: .. code-block:: bash MicroPython v1.13 on 2021-01-01; example-board with unknown-cpu - >>> import usys - >>> usys.implementation + >>> import sys + >>> sys.implementation ('micropython', (1, 13, 0)) >>> diff --git a/docs/esp32/quickref.rst b/docs/esp32/quickref.rst index 56c3721148207..3153ebd57130f 100644 --- a/docs/esp32/quickref.rst +++ b/docs/esp32/quickref.rst @@ -98,7 +98,7 @@ A useful function for connecting to your local WiFi network is:: pass print('network config:', wlan.ifconfig()) -Once the network is established the :mod:`socket ` module can be used +Once the network is established the :mod:`socket ` module can be used to create and use TCP/UDP sockets as usual, and the ``urequests`` module for convenient HTTP requests. @@ -113,7 +113,7 @@ to reconnect forever). Delay and timing ---------------- -Use the :mod:`time ` module:: +Use the :mod:`time