From 3d145af5872c7c37927048f35359cf6e3ebf01ea Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sat, 30 Apr 2022 15:11:00 -0600 Subject: [PATCH] Add note about memory usage for MP3Decoder --- shared-bindings/audiomp3/MP3Decoder.c | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/shared-bindings/audiomp3/MP3Decoder.c b/shared-bindings/audiomp3/MP3Decoder.c index a59d316072..b6539a84b2 100644 --- a/shared-bindings/audiomp3/MP3Decoder.c +++ b/shared-bindings/audiomp3/MP3Decoder.c @@ -35,7 +35,14 @@ #include "supervisor/shared/translate.h" //| class MP3Decoder: -//| """Load a mp3 file for audio playback""" +//| """Load a mp3 file for audio playback +//| +//| .. note:: +//| +//| ``MP3Decoder`` uses a lot of contiguous memory, so care should be given to +//| optimizing memory usage. More information can be found here: +//| https://learn.adafruit.com/Memory-saving-tips-for-CircuitPython/reducing-memory-fragmentation +//| """ //| //| def __init__(self, file: typing.BinaryIO, buffer: WriteableBuffer) -> None: //|