Skip to content

Commit 1d58b55

Browse files
committed
synthio: fix doc build
1 parent f5388e1 commit 1d58b55

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

shared-bindings/synthio/Synthesizer.c

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -293,13 +293,13 @@ MP_PROPERTY_GETTER(synthio_synthesizer_blocks_obj,
293293
//| """Maximum polyphony of the synthesizer (read-only class property)"""
294294
//|
295295

296-
//| def low_pass_filter(cls, cutoff_frequency, q_factor: float = 1 / math.sqrt(2)) -> Biquad:
296+
//| def low_pass_filter(cls, frequency: float, q_factor: float = 0.7071067811865475) -> Biquad:
297297
//| """Construct a low-pass filter with the given parameters.
298298
//|
299-
//| `frequency`, called f0 in the cookbook, is the corner frequency in Hz
299+
//| ``frequency``, called f0 in the cookbook, is the corner frequency in Hz
300300
//| of the filter.
301301
//|
302-
//| `q_factor`, called `Q` in the cookbook. Controls how peaked the response will be at the cutoff frequency. A large value makes the response more peaked.
302+
//| ``q_factor``, called ``Q`` in the cookbook. Controls how peaked the response will be at the cutoff frequency. A large value makes the response more peaked.
303303
//| """
304304

305305
enum passfilter_arg_e { ARG_f0, ARG_Q };
@@ -334,13 +334,15 @@ STATIC mp_obj_t synthio_synthesizer_lpf(size_t n_pos, const mp_obj_t *pos_args,
334334

335335
MP_DEFINE_CONST_FUN_OBJ_KW(synthio_synthesizer_lpf_fun_obj, 1, synthio_synthesizer_lpf);
336336

337-
//| def high_pass_filter(cls, cutoff_frequency, q_factor: float = 1 / math.sqrt(2)) -> Biquad:
337+
//| def high_pass_filter(
338+
//| cls, frequency: float, q_factor: float = 0.7071067811865475
339+
//| ) -> Biquad:
338340
//| """Construct a high-pass filter with the given parameters.
339341
//|
340-
//| `frequency`, called f0 in the cookbook, is the corner frequency in Hz
342+
//| ``frequency``, called f0 in the cookbook, is the corner frequency in Hz
341343
//| of the filter.
342344
//|
343-
//| `q_factor`, called `Q` in the cookbook. Controls how peaked the response will be at the cutoff frequency. A large value makes the response more peaked.
345+
//| ``q_factor``, called ``Q`` in the cookbook. Controls how peaked the response will be at the cutoff frequency. A large value makes the response more peaked.
344346
//| """
345347

346348
STATIC mp_obj_t synthio_synthesizer_hpf(size_t n_pos, const mp_obj_t *pos_args, mp_map_t *kw_args) {
@@ -362,13 +364,15 @@ STATIC mp_obj_t synthio_synthesizer_hpf(size_t n_pos, const mp_obj_t *pos_args,
362364

363365
}
364366

365-
//| def band_pass_filter(cls, frequency, q_factor: float = 1 / math.sqrt(2)) -> Biquad:
367+
//| def band_pass_filter(
368+
//| cls, frequency: float, q_factor: float = 0.7071067811865475
369+
//| ) -> Biquad:
366370
//| """Construct a band-pass filter with the given parameters.
367371
//|
368-
//| `frequency`, called f0 in the cookbook, is the center frequency in Hz
372+
//| ``frequency``, called f0 in the cookbook, is the center frequency in Hz
369373
//| of the filter.
370374
//|
371-
//| `q_factor`, called `Q` in the cookbook. Controls how peaked the response will be at the cutoff frequency. A large value makes the response more peaked.
375+
//| ``q_factor``, called ``Q`` in the cookbook. Controls how peaked the response will be at the cutoff frequency. A large value makes the response more peaked.
372376
//|
373377
//| The coefficients are scaled such that the filter has a 0dB peak gain.
374378
//| """

0 commit comments

Comments
 (0)