fix some doc-comments

Author: elpekenin

ports/espressif/bindings/espulp/ULP.c

@@ -13,7 +13,7 @@
 #include "py/objproperty.h"
 
 //| class ULP:
-//|     def __init__(self, arch: Architecture = Architecture.FSM):
+//|     def __init__(self, arch: Architecture = Architecture.FSM) -> None:
 //|         """The ultra-low-power processor.
 //|
 //|         Raises an exception if another ULP has been instantiated. This

shared-bindings/bitmapfilter/__init__.c

@@ -19,7 +19,7 @@
 //|     mul: float | None = None,
 //|     add: float = 0,
 //|     mask: displayio.Bitmap | None = None,
-//|     threshold=False,
+//|     threshold: bool = False,
 //|     offset: int = 0,
 //|     invert: bool = False,
 //| ) -> displayio.Bitmap:
@@ -406,7 +406,11 @@ static mp_obj_t bitmapfilter_mix(size_t n_args, const mp_obj_t *pos_args, mp_map
 }
 MP_DEFINE_CONST_FUN_OBJ_KW(bitmapfilter_mix_obj, 0, bitmapfilter_mix);
 
-//| def solarize(bitmap, threshold: float = 0.5, mask: displayio.Bitmap | None = None):
+//| def solarize(
+//|     bitmap: displayio.Bitmap,
+//|     threshold: float = 0.5,
+//|     mask: displayio.Bitmap | None = None,
+//| ) -> displayio.Bitmap:
 //|     """Create a "solarization" effect on an image
 //|
 //|     This filter inverts pixels with brightness values above ``threshold``, while leaving

shared-bindings/codeop/__init__.c

@@ -17,7 +17,9 @@ static const char *get_arg_str(mp_obj_t arg, qstr name) {
 //| """Utilities to compile possibly incomplete Python source code."""
 //|
 
-//| def compile_command(source: str, filename: str = "<input>", symbol: str = "single"):
+//| def compile_command(
+//|     source: str, filename: str = "<input>", symbol: str = "single"
+//| ) -> "code":  # NOTE(elpekenin): this type does not seem to exist
 //|     """Compile a command and determine whether it is incomplete
 //|
 //|     The 'completeness' determination is slightly different than in standard Python

shared-bindings/dotclockframebuffer/__init__.c

@@ -30,7 +30,7 @@
 //|     mosi_bit: int,
 //|     clk_bit: int,
 //|     reset_bit: Optional[int],
-//| ):
+//| ) -> None:
 //|     """Send a displayio-style initialization sequence over an I2C I/O expander
 //|
 //|     This function is highly generic in order to support various I/O expanders.

shared-bindings/floppyio/__init__.c

@@ -23,7 +23,7 @@
 //|     buffer: WriteableBuffer,
 //|     data: digitalio.DigitalInOut,
 //|     index: digitalio.DigitalInOut,
-//|     index_wait=0.220,
+//|     index_wait: float = 0.220,
 //| ) -> int:
 //|     """Read flux transition information into the buffer.
 //|

shared-bindings/memorymap/AddressRange.c

@@ -54,7 +54,7 @@
 //|     """
 //|
 
-//|     def __init__(self, *, start, length) -> None:
+//|     def __init__(self, *, start: int, length: int) -> None:
 //|         """Constructs an address range starting at ``start`` and ending at
 //|         ``start + length``. An exception will be raised if any of the
 //|         addresses are invalid or protected."""

shared-bindings/rotaryio/IncrementalEncoder.c

@@ -16,8 +16,8 @@
 
 //| class IncrementalEncoder:
 //|     """IncrementalEncoder determines the relative rotational position based on two series of pulses.
-//|	   It assumes that the encoder's common pin(s) are connected to ground,and enables pull-ups on
-//|	   pin_a and pin_b."""
+//|     It assumes that the encoder's common pin(s) are connected to ground,and enables pull-ups on
+//|     pin_a and pin_b."""
 //|
 //|     def __init__(
 //|         self, pin_a: microcontroller.Pin, pin_b: microcontroller.Pin, divisor: int = 4

shared-bindings/synthio/LFO.c

@@ -74,10 +74,10 @@ static const uint16_t triangle[] = {0, 32767, 0, -32767};
 //|         scale: BlockInput = 1.0,
 //|         offset: BlockInput = 0.0,
 //|         phase_offset: BlockInput = 0.0,
-//|         once=False,
-//|         interpolate=True
-//|     ):
-//|         pass
+//|         once: bool = False,
+//|         interpolate: bool = True,
+//|     ) -> None:
+//|         """Initialize an instance of the class."""
 static const mp_arg_t lfo_properties[] = {
     { MP_QSTR_waveform, MP_ARG_OBJ, {.u_obj = MP_ROM_NONE } },
     { MP_QSTR_rate, MP_ARG_OBJ | MP_ARG_KW_ONLY, {.u_obj = MP_ROM_INT(1) } },
@@ -268,7 +268,7 @@ MP_PROPERTY_GETTER(synthio_lfo_value_obj,
 
 
 //|
-//|     def retrigger(self):
+//|     def retrigger(self) -> None:
 //|         """Reset the LFO's internal index to the start of the waveform. Most useful when it its `once` property is `True`."""
 //|
 static mp_obj_t synthio_lfo_retrigger(mp_obj_t self_in) {

shared-bindings/synthio/Math.c

@@ -133,8 +133,8 @@ MAKE_ENUM_TYPE(synthio, MathOperation, synthio_math_operation,
 //|         a: BlockInput,
 //|         b: BlockInput = 0.0,
 //|         c: BlockInput = 1.0,
-//|     ):
-//|         pass
+//|     ) -> None:
+//|         """Initialize an instance of the class."""
 static const mp_arg_t math_properties[] = {
     { MP_QSTR_operation, MP_ARG_OBJ | MP_ARG_REQUIRED, {.u_obj = NULL } },
     { MP_QSTR_a, MP_ARG_OBJ | MP_ARG_REQUIRED, {.u_obj = NULL } },

shared-bindings/synthio/Synthesizer.c

@@ -106,7 +106,7 @@ static MP_DEFINE_CONST_FUN_OBJ_2(synthio_synthesizer_release_obj, synthio_synthe
 //|         self,
 //|         release: NoteOrNoteSequence = (),
 //|         press: NoteOrNoteSequence = (),
-//|         retrigger=LFOOrLFOSequence,
+//|         retrigger: LFOOrLFOSequence = (),
 //|     ) -> None:
 //|         """Start notes, stop them, and/or re-trigger some LFOs.
 //|