Skip to content

Commit 8ba81b4

Browse files
committed
docs(partial-processor): add simple docstrings to success/failure handlers
1 parent be06149 commit 8ba81b4

File tree

1 file changed

+10
-0
lines changed
  • aws_lambda_powertools/utilities/batch

1 file changed

+10
-0
lines changed

aws_lambda_powertools/utilities/batch/base.py

+10
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,11 @@ class BasePartialProcessor(BaseProcessor):
7171
def success_handler(self, record: Any, result: Any):
7272
"""
7373
Success callback
74+
75+
Returns
76+
-------
77+
tuple
78+
"success", record processing result and original record
7479
"""
7580
entry = ("success", result, record)
7681
self.success_messages.append(record)
@@ -79,6 +84,11 @@ def success_handler(self, record: Any, result: Any):
7984
def failure_handler(self, record: Any, exception: Exception):
8085
"""
8186
Failure callback
87+
88+
Returns
89+
-------
90+
tuple
91+
"fail", exceptions args, original record
8292
"""
8393
entry = ("fail", exception.args, record)
8494
self.fail_messages.append(record)

0 commit comments

Comments
 (0)