synthio: doc fixes

This commit is contained in:
Jeff Epler 2023-05-21 17:49:30 -05:00
parent ac02a2668e
commit 4d60c4608e
No known key found for this signature in database
GPG Key ID: D5BF15AB975AB4DE
3 changed files with 7 additions and 2 deletions

View File

@ -54,6 +54,8 @@ MAKE_ENUM_VALUE(synthio_math_operation_type, math_op, ABS, OP_ABS);
//| class MathOperation:
//| """Operation for a Math block"""
//|
//| def __call__(self, a: BlockInput, b: BlockInput = 0.0, c: BlockInput = 1.0) -> Math:
//| """A MathOperation enumeration value can be called to construct a Math block that performs that operation"""
//| SUM: "MathOperation"
//| """Computes ``a+b+c``. For 2-input sum, set one argument to ``0.0``. To hold a control value for multiple subscribers, set two arguments to ``0.0``."""
//|

View File

@ -275,7 +275,7 @@ MP_PROPERTY_GETTER(synthio_synthesizer_pressed_obj,
//|
//| This can be used to implement 'free-running' LFOs. LFOs associated with playing notes are advanced whether or not they are in this list.
//|
//| This property is read-only but its contents may be modified by e.g., calling ``synth.lfos.append()` or ``synth.lfos.remove(). It is initially an empty list."""
//| This property is read-only but its contents may be modified by e.g., calling ``synth.lfos.append()`` or ``synth.lfos.remove()``. It is initially an empty list."""
//|
STATIC mp_obj_t synthio_synthesizer_obj_get_lfos(mp_obj_t self_in) {
synthio_synthesizer_obj_t *self = MP_OBJ_TO_PTR(self_in);

View File

@ -65,7 +65,10 @@ static const mp_arg_t envelope_properties[] = {
//| """
//|
//| BlockInput = Union["Math", "LFO", float, None]
//| """Blocks and Notes can take any of these types as inputs on certain attributes"""
//| """Blocks and Notes can take any of these types as inputs on certain attributes
//|
//| A BlockInput can be any of the following types: `Math`, `LFO`, `float`, `None` (treated same as 0).
//| """
//|
//| class Envelope:
//| def __init__(