From f14646f3f69386f750c2c457220cb16bdb21b848 Mon Sep 17 00:00:00 2001 From: Talley Lambert Date: Tue, 13 Feb 2024 09:43:49 -0500 Subject: [PATCH] docs: more docs --- src/psygnal/_group.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/psygnal/_group.py b/src/psygnal/_group.py index 94cf1356..095c9c13 100644 --- a/src/psygnal/_group.py +++ b/src/psygnal/_group.py @@ -184,6 +184,14 @@ class SignalGroup: ---------- instance : Any, optional An object to which this SignalGroup is bound, by default None + + Attributes + ---------- + all : SignalRelay + A special SignalRelay instance that can be used to connect to all signals in + this group. The name of this attribute can be overridden by the user by + creating a new name for the SignalRelay annotation on a subclass of SignalGroup + e.g. `my_name: SignalRelay` """ _psygnal_signals: ClassVar[Mapping[str, Signal]]