You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Synthesizer: Match documentation to implementation.
The docstrings incorrectly gave the name of the argument; the code
only accepts the argument name "Q":
```
{ MP_QSTR_Q, MP_ARG_OBJ, {.u_obj = MP_OBJ_NULL } },
```
//| """Construct a low-pass filter with the given parameters.
292
292
//|
293
293
//| ``frequency``, called f0 in the cookbook, is the corner frequency in Hz
294
294
//| of the filter.
295
295
//|
296
-
//| ``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.
296
+
//| ``Q`` controls how peaked the response will be at the cutoff frequency. A large value makes the response more peaked.
//| """Construct a high-pass filter with the given parameters.
335
333
//|
336
334
//| ``frequency``, called f0 in the cookbook, is the corner frequency in Hz
337
335
//| of the filter.
338
336
//|
339
-
//| ``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.
337
+
//| ``Q`` controls how peaked the response will be at the cutoff frequency. A large value makes the response more peaked.
//| """Construct a band-pass filter with the given parameters.
365
361
//|
366
362
//| ``frequency``, called f0 in the cookbook, is the center frequency in Hz
367
363
//| of the filter.
368
364
//|
369
-
//| ``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.
365
+
//| ``Q`` Controls how peaked the response will be at the cutoff frequency. A large value makes the response more peaked.
370
366
//|
371
367
//| The coefficients are scaled such that the filter has a 0dB peak gain.
0 commit comments