Skip to content

Commit 21a5ed5

Browse files
committed
Satisfy pydocstyle linter
1 parent 5213d84 commit 21a5ed5

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

temporalio/worker/_workflow_instance.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2739,17 +2739,23 @@ class _WorkflowBeingEvictedError(BaseException):
27392739

27402740
@dataclass
27412741
class HandlerExecution:
2742+
"""Information about an execution of a signal or update handler."""
2743+
27422744
name: str
27432745
unfinished_handlers_policy: temporalio.workflow.UnfinishedHandlersPolicy
27442746
id: Optional[str] = None
27452747

27462748

27472749
class UnfinishedUpdateHandlerWarning(RuntimeWarning):
2750+
"""Warning issued when a workflow exits before an update handler has finished executing"""
2751+
27482752
def __init__(self, handler_executions: List[HandlerExecution]) -> None:
2753+
"""Initialize warning object"""
27492754
super().__init__()
27502755
self.handler_executions = handler_executions
27512756

27522757
def __str__(self) -> str:
2758+
"""Return warning message"""
27532759
message = """
27542760
Workflow finished while update handlers are still running. This may have interrupted work that the
27552761
update handler was doing, and the client that sent the update will receive a 'workflow execution
@@ -2771,11 +2777,15 @@ def __str__(self) -> str:
27712777

27722778

27732779
class UnfinishedSignalHandlerWarning(RuntimeWarning):
2780+
"""Warning issued when a workflow exits before a signal handler has finished executing"""
2781+
27742782
def __init__(self, handler_executions: List[HandlerExecution]) -> None:
2783+
"""Initialize warning object"""
27752784
super().__init__()
27762785
self.handler_executions = handler_executions
27772786

27782787
def __str__(self) -> str:
2788+
"""Return warning message"""
27792789
message = """
27802790
Workflow finished while signal handlers are still running. This may have interrupted work that the
27812791
signal handler was doing. You can wait for all update and signal handlers to complete by using

0 commit comments

Comments
 (0)