Skip to content

Commit

Permalink
docs: more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tlambert03 committed Feb 13, 2024
1 parent 18d3e25 commit f14646f
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions src/psygnal/_group.py
Original file line number Diff line number Diff line change
Expand Up @@ -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]]
Expand Down

0 comments on commit f14646f

Please sign in to comment.