Skip to content

docs(68): Added some documentation to RaiseAssert methods #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rcardin merged 1 commit into from
Nov 18, 2024
Merged

docs(68): Added some documentation to RaiseAssert methods #69

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions src/main/kotlin/in/rcard/assertj/arrowcore/RaiseAssert.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,16 @@ class RaiseAssert<ERROR : Any, VALUE : Any>(

/**
* Verifies that the function in the [Raise] context throws an exception.
* ### Example:
* ```kotlin
* val throwsException: Raise<String>.() -> Int = {
* throw RuntimeException("AN EXCEPTION")
* }
* assertThatThrownBy { throwsException() }
* .isInstanceOf(RuntimeException::class.java)
* .hasMessage("AN EXCEPTION")
* ```
*
* @param shouldRaiseThrowable the function to be executed in the [Raise] context.
* @return the [AbstractThrowableAssert] to be used to verify the exception.
*/
Expand All @@ -63,6 +73,11 @@ class RaiseAssert<ERROR : Any, VALUE : Any>(

/**
* Verifies that the function in the [Raise] context raises an error.
* ### Example:
* ```kotlin
* val raisesError: Raise<String>.() -> Int = { raise("LOGICAL ERROR") }
* assertThatRaisedBy { raisesError() }.isEqualTo("LOGICAL ERROR")
* ```
* @param shouldRaiseError the function to be executed in the [Raise] context.
* @return the [AbstractObjectAssert] to be used to verify the error.
*/
Expand Down