prepare iterableLike and mapLike toContain samples

robstoll · Sep 26, 2023 · d4933f1 · d4933f1
1 parent e1675fb
commit d4933f1
Show file tree

Hide file tree

Showing 12 changed files with 90 additions and 17 deletions.
diff --git a/...onMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainSearchBehaviours.kt b/...onMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/iterableLikeToContainSearchBehaviours.kt
@@ -9,7 +9,7 @@ import kotlin.jvm.JvmName
 
 /**
  * Defines that the search behaviour "find entries `in any order` in the [IterableLike]" shall be applied to this
- * sophisticated `contains` in [IterableLike] assertion.
+ * sophisticated `to contain` in [IterableLike] expectation.
  *
  * @return The newly created builder.
  *
@@ -20,7 +20,7 @@ val <E, T: IterableLike> EntryPointStep<E, T, NoOpSearchBehaviour>.inAnyOrder: E
 
 /**
  * Defines that the constraint "`only` the specified entries exist in the [IterableLike]" shall be applied to this
- * sophisticated `contains` [IterableLike] assertion.
+ * sophisticated `to contain` in [IterableLike] expectation.
  *
  * @return The newly created builder.
  *
@@ -32,7 +32,7 @@ val <E, T: IterableLike> EntryPointStep<E, T, InAnyOrderSearchBehaviour>.only: E
 
 /**
  * Defines that the search behaviour "find entries `in order` in the [IterableLike]" shall be applied to this
- * sophisticated `contains` in [IterableLike] assertion.
+ * sophisticated `to contain` in [IterableLike] expectation.
  *
  * @return The newly created builder.
  *
@@ -43,7 +43,7 @@ val <E, T: IterableLike> EntryPointStep<E, T, NoOpSearchBehaviour>.inOrder: Entr
 
 /**
  * Defines that the constraint "`only` the specified entries exist in the [IterableLike]" shall be applied to this
- * sophisticated `contains in order` [IterableLike] assertion.
+ * sophisticated `to contain in order` in [IterableLike] expectation.
  *
  * @return The newly created builder.
  *
@@ -65,7 +65,7 @@ val <E, T: IterableLike> EntryPointStep<E, T, InOrderOnlySearchBehaviour>.groupe
     get() = _logic.grouped
 
 /**
- * A filler word to emphasis that the next step defines the order within expected groups of values.
+ * A filler word to emphasise that the next step defines the order within expected groups of values.
  *
  * @return The newly created builder.
  *

diff --git a/.../commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapLikeToContainSearchBehaviours.kt b/.../commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/mapLikeToContainSearchBehaviours.kt
@@ -9,7 +9,7 @@ import kotlin.jvm.JvmName
 
 /**
  * Defines that the search behaviour "find entries `in any order` in the [MapLike]" shall be applied to this
- * sophisticated `contains` in [MapLike] assertion.
+ * sophisticated `to contain` in [MapLike] expectation.
  *
  * @return The newly created builder.
  *
@@ -20,7 +20,7 @@ val <K, V, T: MapLike> EntryPointStep<K, V, T, NoOpSearchBehaviour>.inAnyOrder:
 
 /**
  * Defines that the constraint "`only` the specified entries exist in the [MapLike]" shall be applied to this
- * sophisticated `contains` [MapLike] assertion.
+ * sophisticated `to contain` [MapLike] expectation.
  *
  * @return The newly created builder.
  *
@@ -32,7 +32,7 @@ val <K, V, T: MapLike> EntryPointStep<K, V, T, InAnyOrderSearchBehaviour>.only:
 
 /**
  * Defines that the search behaviour "find entries `in order` in the [MapLike]" shall be applied to this
- * sophisticated `contains` in [MapLike] assertion.
+ * sophisticated `to contain` in [MapLike] expectation.
  *
  * @return The newly created builder.
  *
@@ -43,7 +43,7 @@ val <K, V, T: MapLike> EntryPointStep<K, V, T, NoOpSearchBehaviour>.inOrder: Ent
 
 /**
  * Defines that the constraint "`only` the specified entries exist in the [MapLike]" shall be applied to this
- * sophisticated `contains in order` [MapLike] assertion.
+ * sophisticated `to contain in order` [MapLike] expectation.
  *
  * @return The newly created builder.
  *

diff --git a/.../kotlin/ch/tutteli/atrium/api/fluent/en_GB/samples/IterableLikeToContainCheckerSamples.kt b/.../kotlin/ch/tutteli/atrium/api/fluent/en_GB/samples/IterableLikeToContainCheckerSamples.kt
@@ -0,0 +1,10 @@
+package ch.tutteli.atrium.api.fluent.en_GB.samples
+
+import ch.tutteli.atrium.api.fluent.en_GB.*
+import ch.tutteli.atrium.api.verbs.expect
+import kotlin.test.Test
+
+class IterableLikeToContainCheckerSamples {
+
+
+}
diff --git a/.../tutteli/atrium/api/fluent/en_GB/samples/IterableLikeToContainInAnyOrderCreatorSamples.kt b/.../tutteli/atrium/api/fluent/en_GB/samples/IterableLikeToContainInAnyOrderCreatorSamples.kt
@@ -0,0 +1,9 @@
+package ch.tutteli.atrium.api.fluent.en_GB.samples
+
+import ch.tutteli.atrium.api.fluent.en_GB.*
+import ch.tutteli.atrium.api.verbs.expect
+import kotlin.test.Test
+
+class IterableLikeToContainInAnyOrderCreatorSamples {
+
+}
diff --git a/...teli/atrium/api/fluent/en_GB/samples/IterableLikeToContainInAnyOrderOnlyCreatorSamples.kt b/...teli/atrium/api/fluent/en_GB/samples/IterableLikeToContainInAnyOrderOnlyCreatorSamples.kt
@@ -0,0 +1,9 @@
+package ch.tutteli.atrium.api.fluent.en_GB.samples
+
+import ch.tutteli.atrium.api.fluent.en_GB.*
+import ch.tutteli.atrium.api.verbs.expect
+import kotlin.test.Test
+
+class IterableLikeToContainInAnyOrderOnlyCreatorSamples {
+
+}
diff --git a/...tutteli/atrium/api/fluent/en_GB/samples/IterableLikeToContainInOrderOnlyCreatorSamples.kt b/...tutteli/atrium/api/fluent/en_GB/samples/IterableLikeToContainInOrderOnlyCreatorSamples.kt
@@ -0,0 +1,9 @@
+package ch.tutteli.atrium.api.fluent.en_GB.samples
+
+import ch.tutteli.atrium.api.fluent.en_GB.*
+import ch.tutteli.atrium.api.verbs.expect
+import kotlin.test.Test
+
+class IterableLikeToContainInOrderOnlyCreatorSamples {
+
+}
diff --git a/.../atrium/api/fluent/en_GB/samples/IterableLikeToContainInOrderOnlyGroupedCreatorSamples.kt b/.../atrium/api/fluent/en_GB/samples/IterableLikeToContainInOrderOnlyGroupedCreatorSamples.kt
@@ -0,0 +1,9 @@
+package ch.tutteli.atrium.api.fluent.en_GB.samples
+
+import ch.tutteli.atrium.api.fluent.en_GB.*
+import ch.tutteli.atrium.api.verbs.expect
+import kotlin.test.Test
+
+class IterableLikeToContainInOrderOnlyGroupedCreatorSamples {
+
+}
diff --git a/...in/ch/tutteli/atrium/api/fluent/en_GB/samples/MapLikeToContainInAnyOrderCreatorSamples.kt b/...in/ch/tutteli/atrium/api/fluent/en_GB/samples/MapLikeToContainInAnyOrderCreatorSamples.kt
@@ -0,0 +1,9 @@
+package ch.tutteli.atrium.api.fluent.en_GB.samples
+
+import ch.tutteli.atrium.api.fluent.en_GB.*
+import ch.tutteli.atrium.api.verbs.expect
+import kotlin.test.Test
+
+class MapLikeToContainInAnyOrderCreatorSamples {
+
+}
diff --git a/...h/tutteli/atrium/api/fluent/en_GB/samples/MapLikeToContainInAnyOrderOnlyCreatorSamples.kt b/...h/tutteli/atrium/api/fluent/en_GB/samples/MapLikeToContainInAnyOrderOnlyCreatorSamples.kt
@@ -0,0 +1,9 @@
+package ch.tutteli.atrium.api.fluent.en_GB.samples
+
+import ch.tutteli.atrium.api.fluent.en_GB.*
+import ch.tutteli.atrium.api.verbs.expect
+import kotlin.test.Test
+
+class MapLikeToContainInAnyOrderOnlyCreatorSamples {
+
+}
diff --git a/...n/ch/tutteli/atrium/api/fluent/en_GB/samples/MapLikeToContainInOrderOnlyCreatorSamples.kt b/...n/ch/tutteli/atrium/api/fluent/en_GB/samples/MapLikeToContainInOrderOnlyCreatorSamples.kt
@@ -0,0 +1,9 @@
+package ch.tutteli.atrium.api.fluent.en_GB.samples
+
+import ch.tutteli.atrium.api.fluent.en_GB.*
+import ch.tutteli.atrium.api.verbs.expect
+import kotlin.test.Test
+
+class MapLikeToContainInOrderOnlyCreatorSamples {
+
+}
diff --git a/...monMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeToContainSearchBehaviours.kt b/...monMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/iterableLikeToContainSearchBehaviours.kt
@@ -8,7 +8,7 @@ import ch.tutteli.atrium.logic.creating.iterable.contains.steps.*
 
 /**
  * Defines that the search behaviour "find entries `in any order` in the [IterableLike]" shall be applied to this
- * sophisticated `contains` in [IterableLike] assertion.
+ * sophisticated `to contain` in [IterableLike] expectation.
  *
  * @return The newly created builder.
  *
@@ -20,7 +20,7 @@ infix fun <E, T : IterableLike> EntryPointStep<E, T, NoOpSearchBehaviour>.inAny(
 
 /**
  * Defines that the constraint "`only` the specified entries exist in the [IterableLike]" shall be applied to this
- * sophisticated `contains` [IterableLike] assertion.
+ * sophisticated `to contain` in [IterableLike] expectation.
  *
  * @return The newly created builder.
  *
@@ -33,7 +33,7 @@ infix fun <E, T : IterableLike> EntryPointStep<E, T, InAnyOrderSearchBehaviour>.
 
 /**
  * Defines that the search behaviour "find entries `in order` in the [IterableLike]" shall be applied to this
- * sophisticated `contains` in [IterableLike] assertion.
+ * sophisticated `to contain` in [IterableLike] expectation.
  *
  * @return The newly created builder.
  *
@@ -45,7 +45,7 @@ infix fun <E, T : IterableLike> EntryPointStep<E, T, NoOpSearchBehaviour>.inGive
 
 /**
  * Defines that the constraint "`only` the specified entries exist in the [IterableLike]" shall be applied to this
- * sophisticated `contains in order` [IterableLike] assertion.
+ * sophisticated `to contain in order` [IterableLike] expectation.
  *
  * @return The newly created builder.
  *
@@ -68,7 +68,7 @@ infix fun <E, T : IterableLike> EntryPointStep<E, T, InOrderOnlySearchBehaviour>
 ): EntryPointStep<E, T, InOrderOnlyGroupedSearchBehaviour> = _logic.grouped
 
 /**
- * A filler word to emphasis that the next step defines the order within expected groups of values.
+ * A filler word to emphasise that the next step defines the order within expected groups of values.
  *
  * @return The newly created builder.
  *

diff --git a/...c/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapLikeToContainSearchBehaviours.kt b/...c/commonMain/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapLikeToContainSearchBehaviours.kt
@@ -9,7 +9,7 @@ import kotlin.jvm.JvmName
 
 /**
  * Defines that the search behaviour "find entries `in any order` in the [MapLike]" shall be applied to this
- * sophisticated `contains` in [MapLike] assertion.
+ * sophisticated `to contain` in [MapLike] expectation.
  *
  * @return The newly created builder.
  *
@@ -33,7 +33,7 @@ infix fun <K, V, T: MapLike> EntryPointStep<K, V, T, InAnyOrderSearchBehaviour>.
 
 /**
  * Defines that the search behaviour "find entries `in order` in the [MapLike]" shall be applied to this
- * sophisticated `contains` in [MapLike] assertion.
+ * sophisticated `to contain` in [MapLike] expectation.
  *
  * @return The newly created builder.
  *
@@ -45,7 +45,7 @@ infix fun <K, V, T: MapLike> EntryPointStep<K, V, T, NoOpSearchBehaviour>.inGive
 
 /**
  * Defines that the constraint "`only` the specified entries exist in the [MapLike]" shall be applied to this
- * sophisticated `contains in order` [MapLike] assertion.
+ * sophisticated `to contain in order` [MapLike] expectation.
  *
  * @return The newly created builder.
  *