Skip to content

Commit

Permalink
docs: Messages can be of any type
Browse files Browse the repository at this point in the history
This was changed in v2.0.0, but these docstrings where not updated
accordingly.
  • Loading branch information
jodal committed Sep 9, 2019
1 parent 845cce4 commit 1a6289e
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion pykka/_future.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ def set(self, value=None):
Set the encapsulated value.
:param value: the encapsulated value or nothing
:type value: any picklable object or :class:`None`
:type value: any object or :class:`None`
:raise: an exception if set is called multiple times
"""
raise NotImplementedError
Expand Down
6 changes: 3 additions & 3 deletions pykka/_ref.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ def tell(self, message):
block until a free slot is available.
:param message: message to send
:type message: picklable dict
:type message: any
:raise: :exc:`pykka.ActorDeadError` if actor is not available
:return: nothing
Expand All @@ -77,7 +77,7 @@ def ask(self, message, block=True, timeout=None):
"""
Send message to actor and wait for the reply.
The message must be a picklable dict.
The message can be of any type.
If ``block`` is :class:`False`, it will immediately return a
:class:`Future <pykka.Future>` instead of blocking.
Expand All @@ -88,7 +88,7 @@ def ask(self, message, block=True, timeout=None):
:exc:`pykka.Timeout`.
:param message: message to send
:type message: picklable dict
:type message: any
:param block: whether to block while waiting for a reply
:type block: boolean
Expand Down
2 changes: 1 addition & 1 deletion pykka/_registry.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ def broadcast(cls, message, target_class=None):
actors.
:param message: the message to send
:type message: picklable dict
:type message: any
:param target_class: optional actor class to broadcast the message to
:type target_class: class or class name
Expand Down

0 comments on commit 1a6289e

Please sign in to comment.