Skip to content

Commit 8503318

Browse files
committed
Add Optional to synthio.Biquad in documentation to allow for None value.
1 parent c7e87cf commit 8503318

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

shared-bindings/audiofilters/Filter.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
//|
2424
//| def __init__(
2525
//| self,
26-
//| filter: synthio.Biquad = None,
26+
//| filter: Optional[synthio.Biquad] = None,
2727
//| mix: synthio.BlockInput = 1.0,
2828
//| buffer_size: int = 512,
2929
//| sample_rate: int = 8000,
@@ -38,7 +38,7 @@
3838
//| The mix parameter allows you to change how much of the unchanged sample passes through to
3939
//| the output to how much of the effect audio you hear as the output.
4040
//|
41-
//| :param synthio.Biquad filter: The normalized biquad filter object used to process the signal.
41+
//| :param Optional[synthio.Biquad] filter: The normalized biquad filter object used to process the signal.
4242
//| :param synthio.BlockInput mix: The mix as a ratio of the sample (0.0) to the effect (1.0).
4343
//| :param int buffer_size: The total size in bytes of each of the two playback buffers to use
4444
//| :param int sample_rate: The sample rate to be used
@@ -128,7 +128,7 @@ static mp_obj_t audiofilters_filter_obj___exit__(size_t n_args, const mp_obj_t *
128128
static MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(audiofilters_filter___exit___obj, 4, 4, audiofilters_filter_obj___exit__);
129129

130130

131-
//| filter: synthio.Biquad
131+
//| filter: Optional[synthio.Biquad]
132132
//| """The normalized biquad filter object used to process the signal."""
133133
static mp_obj_t audiofilters_filter_obj_get_filter(mp_obj_t self_in) {
134134
return common_hal_audiofilters_filter_get_filter(self_in);

0 commit comments

Comments
 (0)