From c415c135170ff1be2d78ba09c7e69137a1665686 Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Tue, 27 Sep 2022 14:45:15 -0500 Subject: [PATCH] mend broken doc block Since black_bindings.py will pass each contiguous "//|"-block to black independently, they must each be a fully formed Python item. --- shared-bindings/bitbangio/I2C.c | 2 +- shared-bindings/busio/I2C.c | 2 +- shared-bindings/frequencyio/__init__.c | 1 - shared-bindings/ps2io/__init__.c | 2 -- shared-bindings/pwmio/__init__.c | 1 - shared-bindings/storage/__init__.c | 3 +-- shared-bindings/supervisor/__init__.c | 2 +- 7 files changed, 4 insertions(+), 9 deletions(-) diff --git a/shared-bindings/bitbangio/I2C.c b/shared-bindings/bitbangio/I2C.c index 9c0555dd5a..e89defd8e7 100644 --- a/shared-bindings/bitbangio/I2C.c +++ b/shared-bindings/bitbangio/I2C.c @@ -288,7 +288,7 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_KW(bitbangio_i2c_writeto_obj, 1, bitbangio_i2c_wr //| If ``in_start`` or ``in_end`` is provided, then the input buffer will be sliced //| as if ``in_buffer[in_start:in_end]`` were passed, //| The number of bytes read will be the length of ``out_buffer[in_start:in_end]``. - +//| //| :param int address: 7-bit device address //| :param ~circuitpython_typing.ReadableBuffer out_buffer: buffer containing the bytes to write //| :param ~circuitpython_typing.WriteableBuffer in_buffer: buffer to write into diff --git a/shared-bindings/busio/I2C.c b/shared-bindings/busio/I2C.c index b3afd9801d..354e1b4a82 100644 --- a/shared-bindings/busio/I2C.c +++ b/shared-bindings/busio/I2C.c @@ -289,7 +289,7 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_KW(busio_i2c_writeto_obj, 1, busio_i2c_writeto); //| If ``in_start`` or ``in_end`` is provided, then the input buffer will be sliced //| as if ``in_buffer[in_start:in_end]`` were passed, //| The number of bytes read will be the length of ``out_buffer[in_start:in_end]``. - +//| //| :param int address: 7-bit device address //| :param ~circuitpython_typing.ReadableBuffer out_buffer: buffer containing the bytes to write //| :param ~circuitpython_typing.WriteableBuffer in_buffer: buffer to write into diff --git a/shared-bindings/frequencyio/__init__.c b/shared-bindings/frequencyio/__init__.c index ffbb7af771..6ddac9cc83 100644 --- a/shared-bindings/frequencyio/__init__.c +++ b/shared-bindings/frequencyio/__init__.c @@ -38,7 +38,6 @@ //| .. warning:: This module is not available in SAMD21 builds. See the //| :ref:`module-support-matrix` for more info. //| - //| All classes change hardware state and should be deinitialized when they //| are no longer needed if the program continues after use. To do so, either //| call :py:meth:`!deinit` or use a context manager. See diff --git a/shared-bindings/ps2io/__init__.c b/shared-bindings/ps2io/__init__.c index 517816dbcf..d0c438aebc 100644 --- a/shared-bindings/ps2io/__init__.c +++ b/shared-bindings/ps2io/__init__.c @@ -37,11 +37,9 @@ //| //| The `ps2io` module contains classes to provide PS/2 communication. //| - //| .. warning:: This module is not available in some SAMD21 builds. See the //| :ref:`module-support-matrix` for more info. //| - //| All classes change hardware state and should be deinitialized when they //| are no longer needed if the program continues after use. To do so, either //| call :py:meth:`!deinit` or use a context manager. See diff --git a/shared-bindings/pwmio/__init__.c b/shared-bindings/pwmio/__init__.c index 90aff45819..d56eb1eae8 100644 --- a/shared-bindings/pwmio/__init__.c +++ b/shared-bindings/pwmio/__init__.c @@ -37,7 +37,6 @@ //| //| The `pwmio` module contains classes to provide access to basic pulse IO. //| - //| All classes change hardware state and should be deinitialized when they //| are no longer needed if the program continues after use. To do so, either //| call :py:meth:`!deinit` or use a context manager. See diff --git a/shared-bindings/storage/__init__.c b/shared-bindings/storage/__init__.c index baf91a35c1..b820eea34c 100644 --- a/shared-bindings/storage/__init__.c +++ b/shared-bindings/storage/__init__.c @@ -41,13 +41,12 @@ //| unmounting which is typically handled by the operating system hosting Python. //| CircuitPython does not have an OS, so this module provides this functionality //| directly. - +//| //| For more information regarding using the `storage` module, refer to the `CircuitPython //| Essentials Learn guide //| `_. //| """ //| - //| def mount(filesystem: VfsFat, mount_path: str, *, readonly: bool = False) -> None: //| """Mounts the given filesystem object at the given path. //| diff --git a/shared-bindings/supervisor/__init__.c b/shared-bindings/supervisor/__init__.c index 40f8461af4..8f6a62153d 100644 --- a/shared-bindings/supervisor/__init__.c +++ b/shared-bindings/supervisor/__init__.c @@ -309,7 +309,7 @@ MP_DEFINE_CONST_FUN_OBJ_2(supervisor_reset_terminal_obj, supervisor_reset_termin //| characters. Any omitted arguments will be left at their default values. //| //| This method must be called in boot.py to have any effect. - +//| //| Not available on boards without native USB support. //| """ //| ...