djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
478887c62f
circuitpython/docs/library
History
Alex Robbins 0aa1d3f447 docs/library/ubinascii: Update base64 docs. 
This clarifies return values and the handling of invalid (e.g. newline)
characters.

Encoding conforms to RFC 3548, but decoding does not, as it ignores invalid
characters in base64 input. Instead, it conforms to MIME handling of base64
(RFC 2045).

Note that CPython doesn't document handling of invalid characters in
a2b_base64() docs:
https://docs.python.org/3/library/binascii.html#binascii.a2b_base64 , so
we specify it more explicitly than it, based on CPython's actual behavior
(with which MicroPython now compliant).
2017-08-17 09:25:51 +03:00
..
array.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
btree.rst docs/btree: Use markup adhering to the latest conventions. 2017-06-25 00:17:18 +03:00
builtins.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
cmath.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
esp.rst docs/{esp,pyb,ubinascii}: Use markup adhering to the latest docs conventions. 2017-06-27 00:38:05 +03:00
framebuf.rst docs/{framebuf,usocket}: Use markup adhering to the latest docs conventions. 2017-06-29 02:22:14 +03:00
gc.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
index.rst docs/uerrno: Document "uerrno" module. 2017-07-03 00:55:09 +03:00
lcd160cr.rst docs/lcd160cr: Group related constants together. Use full sentences. 2017-06-25 13:28:23 +03:00
machine.ADC.rst docs/library/machine.*: Add cross-reference label to individual classes. 2017-04-18 15:27:37 +10:00
machine.I2C.rst docs/machine*: Use markup adhering to the latest docs conventions. 2017-06-25 13:30:29 +03:00
machine.Pin.rst docs/machine.Pin: Add on() and off() methods. 2017-05-29 20:56:13 +03:00
machine.rst docs/machine*: Use markup adhering to the latest docs conventions. 2017-06-25 13:30:29 +03:00
machine.RTC.rst docs/library/machine.RTC.rst: Fix typo. 2017-08-14 15:42:25 +10:00
machine.SD.rst various: Spelling fixes 2017-05-29 11:36:05 +03:00
machine.Signal.rst docs/machine.Signal: Add initial draft description of Signal class. 2017-05-14 23:12:06 +03:00
machine.SPI.rst docs/library/machine.SPI: Fix formatting of bullet list to stop warning. 2017-04-18 15:40:04 +10:00
machine.Timer.rst docs/library/machine.*: Add cross-reference label to individual classes. 2017-04-18 15:27:37 +10:00
machine.UART.rst docs/machine*: Use markup adhering to the latest docs conventions. 2017-06-25 13:30:29 +03:00
machine.WDT.rst docs/library/machine.*: Add cross-reference label to individual classes. 2017-04-18 15:27:37 +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/{micropython,sys,uos}: Use markup adhering to the latest docs conventions. 2017-06-28 00:37:47 +03:00
network.rst docs/network: Use markup adhering to the latest docs conventions. 2017-06-26 00:37:30 +03:00
pyb.Accel.rst docs/library/pyb.Accel: Add hardware note about pins used by accel. 2016-12-02 17:39:13 +11:00
pyb.ADC.rst docs: Spelling mistakes 2016-08-02 11:17:46 +03:00
pyb.CAN.rst docs/pyb.*: Use proper class case in method headers. 2016-06-08 16:21:28 +03:00
pyb.DAC.rst docs: Spelling mistakes 2016-08-02 11:17:46 +03:00
pyb.ExtInt.rst docs: Spelling mistakes 2016-08-02 11:17:46 +03:00
pyb.I2C.rst stmhal/i2c: Add option to I2C to enable/disable use of DMA transfers. 2016-11-11 17:36:19 +11:00
pyb.LCD.rst docs/pyb.*: Use proper class case in method headers. 2016-06-08 16:21:28 +03:00
pyb.LED.rst docs/pyb.*: Use proper class case in method headers. 2016-06-08 16:21:28 +03:00
pyb.Pin.rst docs/library/pyb.Pin: Minor typo fix, B6 should be A0. 2017-02-13 11:52:44 +11:00
pyb.rst docs,teensy: Use the name MicroPython consistently in documentation 2017-07-15 11:44:32 +02:00
pyb.RTC.rst docs: Spelling mistakes 2016-08-02 11:17:46 +03:00
pyb.Servo.rst docs/pyb.*: Use proper class case in method headers. 2016-06-08 16:21:28 +03:00
pyb.SPI.rst docs/library/pyb.SPI: init(): Describe "bits" argument. 2016-09-18 21:41:21 +03:00
pyb.Switch.rst stmhal: Add .value() method to Switch object, to mirror Pin and Signal. 2017-06-15 17:34:51 +10:00
pyb.Timer.rst docs: Spelling mistakes 2016-08-02 11:17:46 +03:00
pyb.UART.rst docs/library/pyb.UART: Moved writechar doc to sit with other writes. 2016-12-15 09:59:45 +11:00
pyb.USB_HID.rst stmhal/usb: Add support to receive USB HID messages from host. 2016-10-04 15:38:01 +11:00
pyb.USB_VCP.rst docs: Remove references to readall() and update stream read() docs. 2016-11-14 23:31:40 +11:00
sys.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
ubinascii.rst docs/library/ubinascii: Update base64 docs. 2017-08-17 09:25:51 +03:00
ucollections.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
uctypes.rst docs: Spelling mistakes 2016-08-02 11:17:46 +03:00
uerrno.rst docs/uerrno: Document "uerrno" module. 2017-07-03 00:55:09 +03:00
uhashlib.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
uheapq.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
uio.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
ujson.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
uos.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
ure.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
uselect.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
usocket.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
ussl.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
ustruct.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
utime.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
uzlib.rst docs/uzlib: Update description of decompress() and mention DecompIO. 2017-07-04 02:32:42 +03:00
wipy.rst docs: Add usocket and ussl modules' documentation. 2015-10-21 15:30:56 +02:00