Skip to content

Commit

Permalink
docs: use Google-style docstrings for task results (#2541)
Browse files Browse the repository at this point in the history
docs: use Google-style docstrings for task results

Reviewed-by: Matej Focko
Reviewed-by: Laura Barcziová
  • Loading branch information
softwarefactory-project-zuul[bot] authored Sep 24, 2024
2 parents 4507b83 + ec2b2d6 commit 27aca21
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions packit_service/worker/result.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,13 @@ class TaskResults(dict):

def __init__(self, success: bool, details: Dict[str, Any] = None):
"""
:param success: has the job handler succeeded:
True - we processed the event
False - there was an error while processing it -
usually an exception
:param details: more info from job handler
(optional) 'msg' key contains a message
more keys to be defined
Args:
success: Represents the resulting state of the job handler.
`True`, if we processed the event; `False` an error occurred
while processing it (usually an exception)
details: More information provided by the handler. Optionally
contains the `msg` key with message from the handler. Other keys
to be defined.
"""
super().__init__(self, success=success, details=details or {})

Expand Down

0 comments on commit 27aca21

Please sign in to comment.