Skip to content

Commit 4d60c46

Browse files
committed
synthio: doc fixes
1 parent ac02a26 commit 4d60c46

File tree

3 files changed

+7
-2
lines changed

3 files changed

+7
-2
lines changed

shared-bindings/synthio/Math.c

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ MAKE_ENUM_VALUE(synthio_math_operation_type, math_op, ABS, OP_ABS);
5454
//| class MathOperation:
5555
//| """Operation for a Math block"""
5656
//|
57+
//| def __call__(self, a: BlockInput, b: BlockInput = 0.0, c: BlockInput = 1.0) -> Math:
58+
//| """A MathOperation enumeration value can be called to construct a Math block that performs that operation"""
5759
//| SUM: "MathOperation"
5860
//| """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``."""
5961
//|

shared-bindings/synthio/Synthesizer.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ MP_PROPERTY_GETTER(synthio_synthesizer_pressed_obj,
275275
//|
276276
//| This can be used to implement 'free-running' LFOs. LFOs associated with playing notes are advanced whether or not they are in this list.
277277
//|
278-
//| 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."""
278+
//| 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."""
279279
//|
280280
STATIC mp_obj_t synthio_synthesizer_obj_get_lfos(mp_obj_t self_in) {
281281
synthio_synthesizer_obj_t *self = MP_OBJ_TO_PTR(self_in);

shared-bindings/synthio/__init__.c

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,10 @@ static const mp_arg_t envelope_properties[] = {
6565
//| """
6666
//|
6767
//| BlockInput = Union["Math", "LFO", float, None]
68-
//| """Blocks and Notes can take any of these types as inputs on certain attributes"""
68+
//| """Blocks and Notes can take any of these types as inputs on certain attributes
69+
//|
70+
//| A BlockInput can be any of the following types: `Math`, `LFO`, `float`, `None` (treated same as 0).
71+
//| """
6972
//|
7073
//| class Envelope:
7174
//| def __init__(

0 commit comments

Comments
 (0)