summaryrefslogtreecommitdiff
path: root/shared-bindings/audiobusio/PDMIn.c
diff options
context:
space:
mode:
authorScott Shawcroft <scott.shawcroft@gmail.com>2018-02-20 17:34:59 -0800
committerScott Shawcroft <scott.shawcroft@gmail.com>2018-02-20 17:34:59 -0800
commit20dd3b1e434f57a0609fd5306f47863396d1022e (patch)
tree47d7be30787716fcd95e01723942cdff06b0bd85 /shared-bindings/audiobusio/PDMIn.c
parentee90056866d2a8a1e0eec21f0ce5c60b741ea411 (diff)
Delete a bunch of docs, drivers and examples not relevant to CircuitPython.
This fixes #345 and fixes #215.
Diffstat (limited to 'shared-bindings/audiobusio/PDMIn.c')
-rw-r--r--shared-bindings/audiobusio/PDMIn.c6
1 files changed, 3 insertions, 3 deletions
diff --git a/shared-bindings/audiobusio/PDMIn.c b/shared-bindings/audiobusio/PDMIn.c
index c71f44679..a48b48a2d 100644
--- a/shared-bindings/audiobusio/PDMIn.c
+++ b/shared-bindings/audiobusio/PDMIn.c
@@ -51,7 +51,7 @@
//| :param ~microcontroller.Pin clock_pin: The pin to output the clock to
//| :param ~microcontroller.Pin data_pin: The pin to read the data from
//| :param int frequency: Target frequency of the resulting samples. Check `frequency` for actual value.
-//| Minimum frequency is about 16000 Hz.
+//| Minimum frequency is about 16000 Hz.
//| :param int bit_depth: Final number of bits per sample. Must be divisible by 8
//| :param bool mono: True when capturing a single channel of audio, captures two channels otherwise
//| :param int oversample: Number of single bit samples to decimate into a final sample. Must be divisible by 8
@@ -180,8 +180,8 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(audiobusio_pdmin___exit___obj, 4, 4,
//| audio at the given rate. For internal flash, writing all 1s to the file
//| before recording is recommended to speed up writes.
//|
-//| :return: The number of samples recorded. If this is less than `destination_length`,
-//| some samples were missed due to processing time.
+//| :return: The number of samples recorded. If this is less than ``destination_length``,
+//| some samples were missed due to processing time.
//|
STATIC mp_obj_t audiobusio_pdmin_obj_record(mp_obj_t self_obj, mp_obj_t destination, mp_obj_t destination_length) {
audiobusio_pdmin_obj_t *self = MP_OBJ_TO_PTR(self_obj);