Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Nitpicking : doc error related to reset? #387

Open
bgolinvaux opened this issue Dec 8, 2024 · 0 comments
Open

Nitpicking : doc error related to reset? #387

bgolinvaux opened this issue Dec 8, 2024 · 0 comments

Comments

@bgolinvaux
Copy link

Hello

I am reading this in the docs:

static constexpr const char *EXTERNAL_PLUGIN_PROCESS_DOCSTRING = R"(
Pass a buffer of audio (as a 32- or 64-bit NumPy array) *or* a list of
MIDI messages to this plugin, returning audio.

(If calling this multiple times with multiple effect plugins, consider
creating a :class:`pedalboard.Pedalboard` object instead.)

When provided audio as input, the returned array may contain up to (but not
more than) the same number of samples as were provided. If fewer samples
were returned than expected, the plugin has likely buffered audio inside
itself. To receive the remaining audio, pass another audio buffer into 
``process`` with ``reset`` set to ``True``.

If my understanding of how reset works, should the last sentence be rewritten to To receive the remaining audio, pass another audio buffer into process with reset set to False. ? (since setting reset to True will precisely remove the bufferized audio)

If I am not mistaken, I can do a little PR and maybe look if some other bits of doc mention it.

TIA for your opinion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant