Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jakipatryk committed Feb 10, 2025
1 parent 1112d25 commit 20a6446
Showing 1 changed file with 4 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ import za.co.absa.db.fadb.status.FunctionStatus

/**
* `StatusHandling` is a base trait that defines the interface for handling the status of a function invocation.
* It provides a method to check the status of a function invocation with data.
* It provides a method to check the status of a function invocation.
*/
trait StatusHandling {

/**
* Checks the status of a function invocation.
* @param statusWithData - The status of the function invocation with data.
* @return Either a `StatusException` if the status code indicates an error, or the data (along with the status
* information so that it's retrievable) if the status code is successful.
* @param functionStatus - The status of the function invocation.
* @return Some with a `StatusException` if the status code indicates an error,
* or None if the status code is successful.
*/
def checkStatus(functionStatus: FunctionStatus): Option[StatusException]
}

0 comments on commit 20a6446

Please sign in to comment.