doc: update doc comments for failureHandler

arnabrahman · arnabrahman · commit b27f651e3263 · 2024-11-07T10:53:08.000+06:00
diff --git a/packages/batch/src/SqsFifoPartialProcessorAsync.ts b/packages/batch/src/SqsFifoPartialProcessorAsync.ts
@@ -58,10 +58,9 @@ class SqsFifoPartialProcessorAsync extends BatchProcessor {
 
   /**
    * Handles a failure for a given record.
-   * Adds the current group ID to the set of failed group IDs if `skipGroupOnError` is true.
+   *
    * @param record - The record that failed.
    * @param exception - The error that occurred.
-   * @returns The failure response.
    */
   public failureHandler(
     record: EventSourceDataClassTypes,
diff --git a/packages/batch/src/SqsFifoProcessingUtils.ts b/packages/batch/src/SqsFifoProcessingUtils.ts
@@ -73,6 +73,7 @@ class SqsFifoProcessingUtils {
 
   /**
    * Handles failure for current group
+   * Adds the current group ID to the set of failed group IDs if `skipGroupOnError` is true.
    *
    * @param options - The options for the batch processing.
    */

Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,7 @@ class SqsFifoProcessingUtils {`
`73`	`73`
`74`	`74`	`/**`
`75`	`75`	`* Handles failure for current group`
	`76`	+ * Adds the current group ID to the set of failed group IDs if `skipGroupOnError` is true.
`76`	`77`	`*`
`77`	`78`	`* @param options - The options for the batch processing.`
`78`	`79`	`*/`