From b0fca42fd66a7b7b97abf922751b3b7ef7b698bd Mon Sep 17 00:00:00 2001
From: moon2 <moon2protonmail@protonmail.com>
Date: Fri, 11 Aug 2023 15:55:17 +0000
Subject: [PATCH] bl00mbox: docs update
---
docs/badge/bl00mbox.rst | 11 +++++++++--
python_payload/apps/demo_melodic/__init__.py | 2 +-
python_payload/mypystubs/bl00mbox/_user.pyi | 4 ++--
3 files changed, 12 insertions(+), 5 deletions(-)
diff --git a/docs/badge/bl00mbox.rst b/docs/badge/bl00mbox.rst
index 9f2b1f0ee7..d67269e06c 100644
--- a/docs/badge/bl00mbox.rst
+++ b/docs/badge/bl00mbox.rst
@@ -190,8 +190,15 @@ and we can get them individually:
[channel mixer] (1 connections)
output in [bud 1] lowpass
-As we can see this channel has quite a lot going on. Ideally each application should have
-its own channel(s), so in order to get a free one we'll create a new one without argument:
+As we can see this channel has quite a lot going on. Each application should have its own
+channel(s), so in order to get a free one we'll request a free one from the backend by
+skipping the argument:
+
+.. note::
+ Do not use .Channel(n) in application code, it's for REPL purposes only. Each
+ application manages their own channel(s), so they might clear out your plugins
+ or drag down your performance or other kinds of nasty interferences. Don't do it.
+
.. code-block:: pycon
diff --git a/python_payload/apps/demo_melodic/__init__.py b/python_payload/apps/demo_melodic/__init__.py
index 4bf3d9f977..c4079caded 100644
--- a/python_payload/apps/demo_melodic/__init__.py
+++ b/python_payload/apps/demo_melodic/__init__.py
@@ -74,7 +74,7 @@ def run(ins: InputState) -> None:
def init() -> None:
global synths
for i in range(1):
- synths += [blm.new_patch(bl00mbox.patches.tinysynth_fm)]
+ synths += [blm.new(bl00mbox.patches.tinysynth_fm)]
for synth in synths:
synth.decay(100)
diff --git a/python_payload/mypystubs/bl00mbox/_user.pyi b/python_payload/mypystubs/bl00mbox/_user.pyi
index 4d059c5d79..5b49f53d52 100644
--- a/python_payload/mypystubs/bl00mbox/_user.pyi
+++ b/python_payload/mypystubs/bl00mbox/_user.pyi
@@ -49,8 +49,8 @@ class Channel:
free: bool
def clear(self) -> None: ...
- def new_patch(self, patch: Type[T], init_var: Optional[Any] = None) -> T: ...
- def new_bud(
+ def _new_patch(self, patch: Type[T], init_var: Optional[Any] = None) -> T: ...
+ def _new_bud(
self,
thing: bl00mbox._plugins._Plugin | int,
init_var: Optional[int | float] = None,
--
GitLab