Feature/improve arrow documentation (#3570)

* change search maven central link so that the correct library is listed on the top * correct preposition after "independently" from "from" to "of" * fix tables formatting to silence intellij's warnings
kotest · Jul 26, 2023 · 8a1c042 · 8a1c042
1 parent 2d59bf4
commit 8a1c042
Show file tree

Hide file tree

Showing 6 changed files with 180 additions and 180 deletions.
diff --git a/documentation/docs/assertions/arrow.md b/documentation/docs/assertions/arrow.md
@@ -10,41 +10,41 @@ sidebar_label: Arrow
 This page lists all current matchers in the Kotest arrow matchers extension library.
 
 :::note
-The following module is needed: `io.kotest.extensions:kotest-assertions-arrow` which is versioned independently from the main Kotest project.
-Search maven central for latest version [here](https://search.maven.org/search?q=kotest-assertions-arrow).
+The following module is needed: `io.kotest.extensions:kotest-assertions-arrow` which is versioned independently of the main Kotest project.
+Search maven central for latest version [here](https://central.sonatype.com/search?q=io.kotest.extensions:kotest-assertions-arrow).
 :::
 
 :::note
 In the case `io.arrow-kt:arrow-core:arrow-version` is not in your classpath, please add it. To prevent Unresolved Reference errors.
 :::
 
-| Option | |
-| -------- | ---- |
-| `option.shouldBeSome()` | Asserts that the option is of type Some and returns value |
-| `option.shouldBeSome(v)` | Asserts that the option is of type Some with value v |
-| `option.shouldBeNone()` | Asserts that the option is of type None |
-
-| Either | |
-| -------- | ---- |
-| `either.shouldBeRight()` | Asserts that the either is of type Right and returns the Right value |
-| `either.shouldBeRight(v)` | Asserts that the either is of type Right with specified value v |
-| `either.shouldBeLeft()` | Asserts that the either is of type Left and returns the Left value |
-| `either.shouldBeLeft(v)` | Asserts that the either is of type Left with specific value v |
-
-| NonEmptyList | |
-| -------- | ---- |
-| `nel.shouldContain(e)` | Asserts that the NonEmptyList contains the given element e |
+| Option                   |                                                           |
+|--------------------------|-----------------------------------------------------------|
+| `option.shouldBeSome()`  | Asserts that the option is of type Some and returns value |
+| `option.shouldBeSome(v)` | Asserts that the option is of type Some with value v      |
+| `option.shouldBeNone()`  | Asserts that the option is of type None                   |
+
+| Either                    |                                                                      |
+|---------------------------|----------------------------------------------------------------------|
+| `either.shouldBeRight()`  | Asserts that the either is of type Right and returns the Right value |
+| `either.shouldBeRight(v)` | Asserts that the either is of type Right with specified value v      |
+| `either.shouldBeLeft()`   | Asserts that the either is of type Left and returns the Left value   |
+| `either.shouldBeLeft(v)`  | Asserts that the either is of type Left with specific value v        |
+
+| NonEmptyList                         |                                                                            |
+|--------------------------------------|----------------------------------------------------------------------------|
+| `nel.shouldContain(e)`               | Asserts that the NonEmptyList contains the given element e                 |
 | `nel.shouldContainAll(e1,e2,...,en)` | Asserts that the NonEmptyList contains all the given elements e1,e2,...,en |
-| `nel.shouldContainNull()` | Asserts that the NonEmptyList contains at least one null |
-| `nel.shouldContainNoNulls()` | Asserts that the NonEmptyList contains no nulls |
-| `nel.shouldContainOnlyNulls()` | Asserts that the NonEmptyList contains only nulls or is empty |
-| `nel.shouldHaveDuplicates()` | Asserts that the NonEmptyList has at least one duplicate |
-| `nel.shouldBeSingleElement(e)` | Asserts that the NonEmptyList has a single element which is e |
-| `nel.shouldBeSorted()` | Asserts that the NonEmptyList is sorted |
-
-| Validated | |
-| -------- | ---- |
-| `validated.shouldBeValid()` | Asserts that the validated is of type Valid and returns the Valid value |
-| `validated.shouldBeValid(v)` | Asserts that the validated is of type Valid with specific value v |
-| `validated.shouldBeInvalid()` | Asserts that the validated is of type Invalid and returns the Invalid value|
-| `validated.shouldBeInvalid(v)` | Asserts that the validated is of type Invalid with specific value v |
+| `nel.shouldContainNull()`            | Asserts that the NonEmptyList contains at least one null                   |
+| `nel.shouldContainNoNulls()`         | Asserts that the NonEmptyList contains no nulls                            |
+| `nel.shouldContainOnlyNulls()`       | Asserts that the NonEmptyList contains only nulls or is empty              |
+| `nel.shouldHaveDuplicates()`         | Asserts that the NonEmptyList has at least one duplicate                   |
+| `nel.shouldBeSingleElement(e)`       | Asserts that the NonEmptyList has a single element which is e              |
+| `nel.shouldBeSorted()`               | Asserts that the NonEmptyList is sorted                                    |
+
+| Validated                      |                                                                             |
+|--------------------------------|-----------------------------------------------------------------------------|
+| `validated.shouldBeValid()`    | Asserts that the validated is of type Valid and returns the Valid value     |
+| `validated.shouldBeValid(v)`   | Asserts that the validated is of type Valid with specific value v           |
+| `validated.shouldBeInvalid()`  | Asserts that the validated is of type Invalid and returns the Invalid value |
+| `validated.shouldBeInvalid(v)` | Asserts that the validated is of type Invalid with specific value v         |
diff --git a/documentation/versioned_docs/version-5.2/assertions/arrow.md b/documentation/versioned_docs/version-5.2/assertions/arrow.md
@@ -5,40 +5,40 @@ sidebar_label: Arrow
 ---
 
 
-This page lists all current matchers in the Kotest arrow matchers extension library. 
+This page lists all current matchers in the Kotest arrow matchers extension library.
 
 To use this library you need to add `io.kotest.extensions:kotest-assertions-arrow` to your build.
 
 :::note
 In the case `io.arrow-kt:arrow-core:arrow-version` is not in your classpath, please add it. To prevent Unresolved Reference errors.
 :::
 
-| Option | |
-| -------- | ---- |
-| `option.shouldBeSome()` | Asserts that the option is of type Some and returns value |
-| `option.shouldBeSome(v)` | Asserts that the option is of type Some with value v |
-| `option.shouldBeNone()` | Asserts that the option is of type None |
-
-| Either | |
-| -------- | ---- |
-| `either.shouldBeRight()` | Asserts that the either is of type Right and returns the Right value |
-| `either.shouldBeRight(v)` | Asserts that the either is of type Right with specified value v |
-| `either.shouldBeLeft()` | Asserts that the either is of type Left and returns the Left value |
-| `either.shouldBeLeft(v)` | Asserts that the either is of type Left with specific value v |
-
-| NonEmptyList | |
-| -------- | ---- |
-| `nel.shouldContain(e)` | Asserts that the NonEmptyList contains the given element e |
+| Option                   |                                                           |
+|--------------------------|-----------------------------------------------------------|
+| `option.shouldBeSome()`  | Asserts that the option is of type Some and returns value |
+| `option.shouldBeSome(v)` | Asserts that the option is of type Some with value v      |
+| `option.shouldBeNone()`  | Asserts that the option is of type None                   |
+
+| Either                    |                                                                      |
+|---------------------------|----------------------------------------------------------------------|
+| `either.shouldBeRight()`  | Asserts that the either is of type Right and returns the Right value |
+| `either.shouldBeRight(v)` | Asserts that the either is of type Right with specified value v      |
+| `either.shouldBeLeft()`   | Asserts that the either is of type Left and returns the Left value   |
+| `either.shouldBeLeft(v)`  | Asserts that the either is of type Left with specific value v        |
+
+| NonEmptyList                         |                                                                            |
+|--------------------------------------|----------------------------------------------------------------------------|
+| `nel.shouldContain(e)`               | Asserts that the NonEmptyList contains the given element e                 |
 | `nel.shouldContainAll(e1,e2,...,en)` | Asserts that the NonEmptyList contains all the given elements e1,e2,...,en |
-| `nel.shouldContainNull()` | Asserts that the NonEmptyList contains at least one null |
-| `nel.shouldContainNoNulls()` | Asserts that the NonEmptyList contains no nulls |
-| `nel.shouldContainOnlyNulls()` | Asserts that the NonEmptyList contains only nulls or is empty |
-| `nel.shouldHaveDuplicates()` | Asserts that the NonEmptyList has at least one duplicate |
-| `nel.shouldBeSingleElement(e)` | Asserts that the NonEmptyList has a single element which is e |
-| `nel.shouldBeSorted()` | Asserts that the NonEmptyList is sorted |
-
-| Validated | |
-| -------- | ---- |
-| `validated.shouldBeValid()` | Asserts that the validated is of type Valid and returns the Valid value |
-| `validated.shouldBeValid(v)` | Asserts that the validated is of type Valid with specific value v |
-| `validated.shouldBeInvalid()` | Asserts that the validated is of type Invalid and returns the Invalid value|
+| `nel.shouldContainNull()`            | Asserts that the NonEmptyList contains at least one null                   |
+| `nel.shouldContainNoNulls()`         | Asserts that the NonEmptyList contains no nulls                            |
+| `nel.shouldContainOnlyNulls()`       | Asserts that the NonEmptyList contains only nulls or is empty              |
+| `nel.shouldHaveDuplicates()`         | Asserts that the NonEmptyList has at least one duplicate                   |
+| `nel.shouldBeSingleElement(e)`       | Asserts that the NonEmptyList has a single element which is e              |
+| `nel.shouldBeSorted()`               | Asserts that the NonEmptyList is sorted                                    |
+
+| Validated                     |                                                                             |
+|-------------------------------|-----------------------------------------------------------------------------|
+| `validated.shouldBeValid()`   | Asserts that the validated is of type Valid and returns the Valid value     |
+| `validated.shouldBeValid(v)`  | Asserts that the validated is of type Valid with specific value v           |
+| `validated.shouldBeInvalid()` | Asserts that the validated is of type Invalid and returns the Invalid value |
diff --git a/documentation/versioned_docs/version-5.3/assertions/arrow.md b/documentation/versioned_docs/version-5.3/assertions/arrow.md
@@ -5,40 +5,40 @@ sidebar_label: Arrow
 ---
 
 
-This page lists all current matchers in the Kotest arrow matchers extension library. 
+This page lists all current matchers in the Kotest arrow matchers extension library.
 
 To use this library you need to add `io.kotest.extensions:kotest-assertions-arrow` to your build.
 
 :::note
 In the case `io.arrow-kt:arrow-core:arrow-version` is not in your classpath, please add it. To prevent Unresolved Reference errors.
 :::
 
-| Option | |
-| -------- | ---- |
-| `option.shouldBeSome()` | Asserts that the option is of type Some and returns value |
-| `option.shouldBeSome(v)` | Asserts that the option is of type Some with value v |
-| `option.shouldBeNone()` | Asserts that the option is of type None |
-
-| Either | |
-| -------- | ---- |
-| `either.shouldBeRight()` | Asserts that the either is of type Right and returns the Right value |
-| `either.shouldBeRight(v)` | Asserts that the either is of type Right with specified value v |
-| `either.shouldBeLeft()` | Asserts that the either is of type Left and returns the Left value |
-| `either.shouldBeLeft(v)` | Asserts that the either is of type Left with specific value v |
-
-| NonEmptyList | |
-| -------- | ---- |
-| `nel.shouldContain(e)` | Asserts that the NonEmptyList contains the given element e |
+| Option                   |                                                           |
+|--------------------------|-----------------------------------------------------------|
+| `option.shouldBeSome()`  | Asserts that the option is of type Some and returns value |
+| `option.shouldBeSome(v)` | Asserts that the option is of type Some with value v      |
+| `option.shouldBeNone()`  | Asserts that the option is of type None                   |
+
+| Either                    |                                                                      |
+|---------------------------|----------------------------------------------------------------------|
+| `either.shouldBeRight()`  | Asserts that the either is of type Right and returns the Right value |
+| `either.shouldBeRight(v)` | Asserts that the either is of type Right with specified value v      |
+| `either.shouldBeLeft()`   | Asserts that the either is of type Left and returns the Left value   |
+| `either.shouldBeLeft(v)`  | Asserts that the either is of type Left with specific value v        |
+
+| NonEmptyList                         |                                                                            |
+|--------------------------------------|----------------------------------------------------------------------------|
+| `nel.shouldContain(e)`               | Asserts that the NonEmptyList contains the given element e                 |
 | `nel.shouldContainAll(e1,e2,...,en)` | Asserts that the NonEmptyList contains all the given elements e1,e2,...,en |
-| `nel.shouldContainNull()` | Asserts that the NonEmptyList contains at least one null |
-| `nel.shouldContainNoNulls()` | Asserts that the NonEmptyList contains no nulls |
-| `nel.shouldContainOnlyNulls()` | Asserts that the NonEmptyList contains only nulls or is empty |
-| `nel.shouldHaveDuplicates()` | Asserts that the NonEmptyList has at least one duplicate |
-| `nel.shouldBeSingleElement(e)` | Asserts that the NonEmptyList has a single element which is e |
-| `nel.shouldBeSorted()` | Asserts that the NonEmptyList is sorted |
-
-| Validated | |
-| -------- | ---- |
-| `validated.shouldBeValid()` | Asserts that the validated is of type Valid and returns the Valid value |
-| `validated.shouldBeValid(v)` | Asserts that the validated is of type Valid with specific value v |
-| `validated.shouldBeInvalid()` | Asserts that the validated is of type Invalid and returns the Invalid value|
+| `nel.shouldContainNull()`            | Asserts that the NonEmptyList contains at least one null                   |
+| `nel.shouldContainNoNulls()`         | Asserts that the NonEmptyList contains no nulls                            |
+| `nel.shouldContainOnlyNulls()`       | Asserts that the NonEmptyList contains only nulls or is empty              |
+| `nel.shouldHaveDuplicates()`         | Asserts that the NonEmptyList has at least one duplicate                   |
+| `nel.shouldBeSingleElement(e)`       | Asserts that the NonEmptyList has a single element which is e              |
+| `nel.shouldBeSorted()`               | Asserts that the NonEmptyList is sorted                                    |
+
+| Validated                     |                                                                             |
+|-------------------------------|-----------------------------------------------------------------------------|
+| `validated.shouldBeValid()`   | Asserts that the validated is of type Valid and returns the Valid value     |
+| `validated.shouldBeValid(v)`  | Asserts that the validated is of type Valid with specific value v           |
+| `validated.shouldBeInvalid()` | Asserts that the validated is of type Invalid and returns the Invalid value |