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.
This commit is contained in:
Jeff Epler 2022-09-27 14:45:15 -05:00
parent da4f2db1df
commit c415c13517
No known key found for this signature in database
GPG Key ID: D5BF15AB975AB4DE
7 changed files with 4 additions and 9 deletions

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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
//| <https://learn.adafruit.com/circuitpython-essentials/circuitpython-storage>`_.
//| """
//|
//| def mount(filesystem: VfsFat, mount_path: str, *, readonly: bool = False) -> None:
//| """Mounts the given filesystem object at the given path.
//|

View File

@ -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.
//| """
//| ...