From 59a43f77931a03b2cd47fd25d60763c8090b37b8 Mon Sep 17 00:00:00 2001 From: cketti Date: Wed, 6 Mar 2024 14:02:21 +0100 Subject: [PATCH] Fix code samples in KDoc comments --- .../commonMain/kotlin/assertk/assertions/iterable.kt | 10 +++++----- .../commonMain/kotlin/assertk/assertions/predicate.kt | 2 +- .../commonMain/kotlin/assertk/assertions/sequence.kt | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/assertk/src/commonMain/kotlin/assertk/assertions/iterable.kt b/assertk/src/commonMain/kotlin/assertk/assertions/iterable.kt index 36fdf1c3..65861d3d 100644 --- a/assertk/src/commonMain/kotlin/assertk/assertions/iterable.kt +++ b/assertk/src/commonMain/kotlin/assertk/assertions/iterable.kt @@ -224,7 +224,7 @@ fun Assert>.none(f: (Assert) -> Unit) = * The given lambda will be run for each item. * * ``` - * assert(listOf(-1, 1, 2)).atLeast(2) { it.isPositive() } + * assertThat(listOf(-1, 1, 2)).atLeast(2) { it.isPositive() } * ``` */ fun > Assert.atLeast(times: Int, f: (Assert) -> Unit) = @@ -239,7 +239,7 @@ fun > Assert.atLeast(times: Int, f: (Assert) -> Unit) = * The given lambda will be run for each item. * * ``` - * assert(listOf(-2, -1, 1)).atMost(2) { it.isPositive() } + * assertThat(listOf(-2, -1, 1)).atMost(2) { it.isPositive() } * ``` */ fun > Assert.atMost(times: Int, f: (Assert) -> Unit) = @@ -254,7 +254,7 @@ fun > Assert.atMost(times: Int, f: (Assert) -> Unit) = * The given lambda will be run for each item. * * ``` - * assert(listOf(-1, 1, 2)).exactly(2) { it.isPositive() } + * assertThat(listOf(-1, 1, 2)).exactly(2) { it.isPositive() } * ``` */ fun > Assert.exactly(times: Int, f: (Assert) -> Unit) = @@ -269,7 +269,7 @@ fun > Assert.exactly(times: Int, f: (Assert) -> Unit) = * The given lambda will be run for each item. * * ``` - * assert(listOf(-1, -2, 1)).any { it.isPositive() } + * assertThat(listOf(-1, -2, 1)).any { it.isPositive() } * ``` */ fun > Assert.any(f: (Assert) -> Unit) = @@ -330,4 +330,4 @@ fun > Assert.single(): Assert { expected("to have single element but was empty") } } -} \ No newline at end of file +} diff --git a/assertk/src/commonMain/kotlin/assertk/assertions/predicate.kt b/assertk/src/commonMain/kotlin/assertk/assertions/predicate.kt index 1f2a1efe..a0e0106f 100644 --- a/assertk/src/commonMain/kotlin/assertk/assertions/predicate.kt +++ b/assertk/src/commonMain/kotlin/assertk/assertions/predicate.kt @@ -8,7 +8,7 @@ import assertk.assertions.support.expected * * ``` * val divisibleBy5 : (Int) -> Boolean = { it % 5 == 0 } - * assert(10).matchesPredicate(divisibleBy5) + * assertThat(10).matchesPredicate(divisibleBy5) * ``` */ fun Assert.matchesPredicate(f: (T) -> Boolean) = given { actual -> diff --git a/assertk/src/commonMain/kotlin/assertk/assertions/sequence.kt b/assertk/src/commonMain/kotlin/assertk/assertions/sequence.kt index 291d2103..cdd70443 100644 --- a/assertk/src/commonMain/kotlin/assertk/assertions/sequence.kt +++ b/assertk/src/commonMain/kotlin/assertk/assertions/sequence.kt @@ -245,7 +245,7 @@ fun Assert>.none(f: (Assert) -> Unit) = * The given lambda will be run for each item. * * ``` - * assert(sequenceOf(-1, 1, 2)).atLeast(2) { it.isPositive() } + * assertThat(sequenceOf(-1, 1, 2)).atLeast(2) { it.isPositive() } * ``` */ fun > Assert.atLeast(times: Int, f: (Assert) -> Unit) = @@ -260,7 +260,7 @@ fun > Assert.atLeast(times: Int, f: (Assert) -> Unit) = * The given lambda will be run for each item. * * ``` - * assert(sequenceOf(-2, -1, 1)).atMost(2) { it.isPositive() } + * assertThat(sequenceOf(-2, -1, 1)).atMost(2) { it.isPositive() } * ``` */ fun > Assert.atMost(times: Int, f: (Assert) -> Unit) = @@ -275,7 +275,7 @@ fun > Assert.atMost(times: Int, f: (Assert) -> Unit) = * The given lambda will be run for each item. * * ``` - * assert(sequenceOf(-1, 1, 2)).exactly(2) { it.isPositive() } + * assertThat(sequenceOf(-1, 1, 2)).exactly(2) { it.isPositive() } * ``` */ fun > Assert.exactly(times: Int, f: (Assert) -> Unit) = @@ -290,7 +290,7 @@ fun > Assert.exactly(times: Int, f: (Assert) -> Unit) = * The given lambda will be run for each item. * * ``` - * assert(sequenceOf(-1, -2, 1)).any { it.isPositive() } + * assertThat(sequenceOf(-1, -2, 1)).any { it.isPositive() } * ``` */ fun > Assert.any(f: (Assert) -> Unit) =