djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
a565811f23
circuitpython/docs/library
History
David Lechner a565811f23 extmod/modbtree: Use buffer protocol for keys/values. 
This changes the btree implementation to use the buffer protocol for
reading key/values in all methods.  `str` and `bytes` objects are not the
only bytes-like objects that could be used.

Documentation and tests are also updated.

Addresses issue #8748.

Signed-off-by: David Lechner <david@pybricks.com>
2022-06-21 00:44:49 +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 extmod/modubinascii: Add newline keyword to b2a_base64 function. 2022-01-23 10:18:01 +11:00
bluetooth.rst extmod/modbluetooth: Support gap_connect(None) to cancel a connection. 2021-12-01 11:56:37 +11:00
btree.rst extmod/modbtree: Use buffer protocol for keys/values. 2022-06-21 00:44:49 +10:00
builtins.rst docs/library/builtins.rst: Add module title. 2021-08-17 11:26:24 +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/library/collections.rst: Use class for deque and OrderedDict. 2022-02-09 15:00:00 +11: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
esp32.rst esp32/modesp32: Add new gpio_deep_sleep_hold function. 2022-03-21 23:59:07 +11:00
esp.rst docs/library/esp.rst: Document the osdebug function. 2022-02-09 15:06:19 +11:00
framebuf.rst docs/library/framebuf.rst: Adjust dimensions in example. 2021-11-17 14:36:33 +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: Remove trailing spaces and convert tabs to spaces. 2021-12-15 11:49:22 +11:00
index.rst drivers/codec: Add driver for the WM8960 codec. 2022-04-04 16:31:17 +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: Remove trailing spaces and convert tabs to spaces. 2021-12-15 11:49:22 +11:00
machine.ADC.rst docs/library: Specify additional ADC methods and new ADCBlock class. 2022-01-21 22:35:23 +11:00
machine.ADCBlock.rst docs/library: Specify additional ADC methods and new ADCBlock class. 2022-01-21 22:35:23 +11:00
machine.ADCWiPy.rst docs: Remove trailing spaces and convert tabs to spaces. 2021-12-15 11:49:22 +11:00
machine.I2C.rst extmod/machine_i2c: Increase default SoftI2C timeout to 50ms. 2022-01-21 15:10:30 +11:00
machine.I2S.rst drivers/codec: Add driver for the WM8960 codec. 2022-04-04 16:31:17 +10:00
machine.Pin.rst docs/library/machine.Pin: Update to use preferred DRIVE_x constants. 2022-03-07 23:47:45 +11:00
machine.PWM.rst docs: Add quickref and docs for mimxrt, including network.LAN docs. 2022-04-04 14:11:31 +10:00
machine.rst docs/library: Specify additional ADC methods and new ADCBlock class. 2022-01-21 22:35:23 +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: Remove trailing spaces and convert tabs to spaces. 2021-12-15 11:49:22 +11:00
machine.SDCard.rst docs: Add quickref and docs for mimxrt, including network.LAN docs. 2022-04-04 14:11:31 +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.SPI.rst docs/library/machine.SPI.rst: Add class constant SoftSPI.MSB and .LSB. 2022-02-09 15:05:38 +11:00
machine.Timer.rst docs/library/machine.Timer.rst: Document period and callback args. 2021-11-30 22:29:03 +11:00
machine.TimerWiPy.rst docs: Remove trailing spaces and convert tabs to spaces. 2021-12-15 11:49:22 +11:00
machine.UART.rst docs/library/machine.UART.rst: Add details for invert parameter. 2022-03-07 14:12:50 +11:00
machine.WDT.rst docs/library/machine.WDT.rst: Use correct case for WDT.feed. 2022-02-09 15:05:49 +11: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
neopixel.rst docs: Add docs for machine.bitstream and neopixel module. 2021-08-19 22:50:32 +10:00
network.CC3K.rst all: Replace busses with buses. 2021-05-20 23:22:03 +10:00
network.LAN.rst docs: Add quickref and docs for mimxrt, including network.LAN docs. 2022-04-04 14:11:31 +10:00
network.rst docs: Update to use new WLAN argument names for ssid/security/key. 2022-06-17 21:43:44 +10:00
network.WIZNET5K.rst all: Rename MICROPY_PY_WIZNET5K to MICROPY_PY_NETWORK_WIZNET5K. 2022-06-07 16:55:18 +10:00
network.WLAN.rst docs: Update to use new WLAN argument names for ssid/security/key. 2022-06-17 21:43:44 +10:00
network.WLANWiPy.rst docs: Change \* to * in argument lists. 2020-08-21 12:24:13 +10:00
os.rst docs/library/os.rst: Clarify littlefs requirements for block erase. 2021-09-10 15:21:12 +10:00
pyb.Accel.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.ADC.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.CAN.rst docs/library/pyb.CAN: Update CAN docs to match revised API. 2022-04-02 22:46:07 +11:00
pyb.DAC.rst docs/library/pyb.DAC.rst: Add DAC class constants. 2022-02-09 15:05:26 +11: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: Use the correct * keyword-only notation. 2022-02-09 15:01:00 +11:00
pyb.rst docs/library/pyb.rst: Add pyb.hid_mouse and pyb.hid_keyboard constants. 2022-02-09 15:04:57 +11:00
pyb.RTC.rst docs,stm32: Fix minor typos in RTC docs, and->an. 2021-01-30 14:13:30 +11: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.rst: Document default for prescaler argument. 2022-02-09 15:06:34 +11: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/library/pyb.Timer.rst: Add pyb.Timer class constants. 2022-02-09 15:04:24 +11: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
random.rst docs/library/random.rst: Document the random module. 2021-10-13 16:56:37 +11: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.rst docs: Update Raspberry Pi URLs from .org to .com. 2022-06-14 11:41:13 +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
select.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
socket.rst docs/library/socket.rst: Document socket as a class. 2022-02-09 15:03:26 +11:00
ssl.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
stm.rst docs/library/stm.rst: Document the stm module. 2021-10-14 23:19:08 +11:00
struct.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
sys.rst py/modsys: Introduce sys.implementation._machine constant. 2022-04-28 17:23:03 +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: Fix description of ThreadSafeFlag.wait. 2022-02-09 16:09:48 +11: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
wm8960.rst drivers/codec: Add driver for the WM8960 codec. 2022-04-04 16:31:17 +10: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