Skip to content

Commit

Permalink
Update docstrings
Browse files Browse the repository at this point in the history
Signed-off-by: liamhuber <liamhuber@greyhavensolutions.com>
  • Loading branch information
liamhuber committed Jan 22, 2025
1 parent 2465567 commit b6d3468
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions pyiron_workflow/channels.py
Original file line number Diff line number Diff line change
Expand Up @@ -296,8 +296,9 @@ class DataChannel(FlavorChannel["DataChannel"], typing.Generic[ReceiverType], AB
more specific than the input channel.
In addition to connections, these channels can have a single partner
(:attr:`value_receiver: DataChannel`) that is of the _same_ class and obeys type
hints as though it were the "downstream" (input) partner in a connection.
(:attr:`value_receiver`) that is of the same data flavor and the same direction
(i.e. input or output) and obeys type hints as though it were the "downstream"
(input) partner in a connection.
Channels with such partners pass any data updates they receive directly to this
partner (via the :attr:`value` setter).
(This is helpful for passing data between scopes, where we want input at one scope
Expand Down Expand Up @@ -351,9 +352,9 @@ class DataChannel(FlavorChannel["DataChannel"], typing.Generic[ReceiverType], AB
when this channel is a value receiver. This can potentially be expensive, so
consider deactivating strict hints everywhere for production runs. (Default
is True, raise exceptions when type hints get violated.)
value_receiver (pyiron_workflow.compatibility.Self|None): Another channel of
the same class whose value will always get updated when this channel's
value gets updated.
value_receiver (ReceiverType|None): Another channel of the receiver type (i.e.
also a data flavor and matching input/output type) whose value will always
get updated when this channel's value gets updated.
"""

def __init__(
Expand Down

0 comments on commit b6d3468

Please sign in to comment.