mirror
/
micropython
kopia lustrzana https://github.com/micropython/micropython
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność
micropython/docs/library
Historia
Jim Mussared c737cde947 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>
 		2021-08-13 22:53:29 +10:00
..
_thread.rst docs/_thread: Add a placeholder docs for _thread module. 2017-11-10 00:09:43 +02:00
array.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
binascii.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
bluetooth.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
btree.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
builtins.rst py/objexcept: Support errno attribute on OSError exceptions. 2021-04-23 22:03:46 +10:00
cmath.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
collections.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
cryptolib.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
errno.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
esp.rst docs/library: Clarify that the arg to esp.deepsleep is in microseconds. 2020-06-30 22:01:44 +10:00
esp32.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
framebuf.rst docs/library: Fix framebuf monochrome 1-bit modes, swapping HLSB/HMSB. 2020-02-10 23:04:15 +11:00
gc.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
hashlib.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
heapq.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
index.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
io.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
json.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
lcd160cr.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
machine.ADC.rst docs/library: Specify new machine.ADC class. 2019-09-04 15:35:09 +10:00
machine.ADCWiPy.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
machine.I2C.rst docs: Replace master/slave with controller/peripheral in I2C and SPI. 2021-07-18 11:19:44 +10:00
machine.I2S.rst docs/library/machine.I2S.rst: Fix use of sd pin in examples. 2021-08-07 20:40:54 +10:00
machine.PWM.rst docs/library/machine: Specify initial machine.PWM class. 2021-04-30 16:42:51 +10:00
machine.Pin.rst docs/library/machine.Pin.rst: Make it clear which methods are not core. 2021-02-03 00:54:18 +11:00
machine.RTC.rst docs/library/machine.RTC.rst: Document datetime method and fix ex code. 2021-06-12 22:53:49 +10:00
machine.SD.rst docs/machine: Add initial docs for new machine.SDCard class. 2019-06-03 00:42:24 +10:00
machine.SDCard.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
machine.SPI.rst docs: Replace master/slave with controller/peripheral in I2C and SPI. 2021-07-18 11:19:44 +10:00
machine.Signal.rst docs/library/machine.Signal.rst: Correct typo: usecases to use cases. 2020-10-20 17:21:30 +11:00
machine.Timer.rst docs: Fix some spelling mistakes. 2021-05-04 22:58:00 +10:00
machine.TimerWiPy.rst docs: Fix some spelling mistakes. 2021-05-04 22:58:00 +10:00
machine.UART.rst esp32/machine_uart: Add flow kw-arg to enable hardware flow control. 2021-08-04 13:52:15 +10:00
machine.WDT.rst docs/library: Fix docs for machine.WDT to specify millisecond timeout. 2020-05-02 22:55:48 +10:00
machine.rst esp32,stm32: Add new machine.I2S class for I2S protocol support. 2021-07-05 23:42:25 +10:00
math.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
micropython.rst docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build. 2020-06-05 21:42:17 +10:00
network.CC3K.rst all: Replace busses with buses. 2021-05-20 23:22:03 +10:00
network.WIZNET5K.rst all: Replace busses with buses. 2021-05-20 23:22:03 +10:00
network.WLAN.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
network.WLANWiPy.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
network.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
os.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
pyb.ADC.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.Accel.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.CAN.rst all: Replace busses with buses. 2021-05-20 23:22:03 +10:00
pyb.DAC.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.ExtInt.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.Flash.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
pyb.I2C.rst docs: Replace master/slave with controller/peripheral in I2C and SPI. 2021-07-18 11:19:44 +10:00
pyb.LCD.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.LED.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.Pin.rst docs/library/pyb.Pin.rst: Update the arguments for Pin.init(). 2021-05-20 23:08:43 +10:00
pyb.RTC.rst docs,stm32: Fix minor typos in RTC docs, and->an. 2021-01-30 14:13:30 +11:00
pyb.SPI.rst docs: Replace master/slave with controller/peripheral in I2C and SPI. 2021-07-18 11:19:44 +10:00
pyb.Servo.rst docs/pyb.*: Use proper class case in method headers. 2016-06-08 16:21:28 +03:00
pyb.Switch.rst docs: Fix some references and RST markup to eliminate Sphinx warnings. 2018-03-15 15:50:51 +11:00
pyb.Timer.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.UART.rst all: Replace busses with buses. 2021-05-20 23:22:03 +10:00
pyb.USB_HID.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.USB_VCP.rst stm32/usb: Make irq's default trigger enable all events. 2021-06-23 16:11:37 +10:00
pyb.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
re.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
rp2.Flash.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
rp2.PIO.rst docs/library: Add initial API reference for rp2 module and its classes. 2021-05-08 18:02:04 +10:00
rp2.StateMachine.rst docs/library: Add initial API reference for rp2 module and its classes. 2021-05-08 18:02:04 +10:00
rp2.rst docs/library/rp2.rst: Fix typo overriden->overridden. 2021-05-12 00:05:55 +10:00
select.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
socket.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
ssl.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
struct.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
sys.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
time.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
uasyncio.rst docs/library/uasyncio.rst: Document stream readexactly() method. 2021-07-22 22:39:04 +10:00
uctypes.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
wipy.rst docs: Add usocket and ussl modules' documentation. 2015-10-21 15:30:56 +02:00
zephyr.DiskAccess.rst docs/library/zephyr: Add libraries specific to the Zephyr port. 2021-08-13 20:21:14 +10:00
zephyr.FlashArea.rst docs/library/zephyr: Add libraries specific to the Zephyr port. 2021-08-13 20:21:14 +10:00
zephyr.rst docs/library/zephyr: Add libraries specific to the Zephyr port. 2021-08-13 20:21:14 +10:00
zephyr.zsensor.rst docs/library/zephyr: Add libraries specific to the Zephyr port. 2021-08-13 20:21:14 +10:00
zlib.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00