Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
44 changes: 22 additions & 22 deletions docs/src/modules/is.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Returns `true` when `v` is a boolean.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isBoolean` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -110,7 +110,7 @@ Returns `true` when `v` is a function.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isFunction` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -130,7 +130,7 @@ Returns `true` when `v` is `nil`.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isNil` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -150,7 +150,7 @@ Returns `true` when `v` is a number.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isNumber` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -170,7 +170,7 @@ Returns `true` when `v` is a string.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isString` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -190,7 +190,7 @@ Returns `true` when `v` is a table.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isTable` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -210,7 +210,7 @@ Returns `true` when `v` is a thread.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isThread` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -230,7 +230,7 @@ Returns `true` when `v` is userdata.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isUserdata` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -252,7 +252,7 @@ Returns `true` when `v` is exactly `false`.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isFalse` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -272,7 +272,7 @@ Returns `true` when `v` is exactly `true`.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isTrue` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -292,7 +292,7 @@ Returns `true` when `v` is falsy.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isFalsy` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -312,7 +312,7 @@ Returns `true` when `v` is callable.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isCallable` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -332,7 +332,7 @@ Returns `true` when `v` is an integer.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isInteger` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -352,7 +352,7 @@ Returns `true` when `v` is truthy.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isTruthy` (`boolean`): Whether the check succeeds.

**Example**:

Expand Down Expand Up @@ -380,7 +380,7 @@ Returns `true` when `v` is a block device path.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isBlock` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -400,7 +400,7 @@ Returns `true` when `v` is a character device path.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isChar` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -420,7 +420,7 @@ Returns `true` when `v` is a block or character device path.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isDevice` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -440,7 +440,7 @@ Returns `true` when `v` is a directory path.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isDir` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -460,7 +460,7 @@ Returns `true` when `v` is a FIFO path.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isFifo` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -480,7 +480,7 @@ Returns `true` when `v` is a file path.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isFile` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -500,7 +500,7 @@ Returns `true` when `v` is a symlink path.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isLink` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -520,7 +520,7 @@ Returns `true` when `v` is a socket path.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isSocket` (`boolean`): Whether the check succeeds.

**Example**:

Expand Down
6 changes: 3 additions & 3 deletions docs/src/modules/keyword.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Return `true` when `v` is a reserved Lua keyword.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isKeyword` (`boolean`): Whether the check succeeds.

**Example**:

Expand All @@ -58,7 +58,7 @@ Return `true` when `v` is a valid non-keyword Lua identifier.

**Return**:

- `ok` (`boolean`): Whether the check succeeds.
- `isIdentifier` (`boolean`): Whether the check succeeds.

**Example**:

Expand Down Expand Up @@ -111,7 +111,7 @@ Normalize an input into a safe Lua identifier.

**Return**:

- `ident` (`string`): Normalized Lua identifier.
- `identifier` (`string`): Normalized Lua identifier.

**Example**:

Expand Down
38 changes: 19 additions & 19 deletions docs/src/modules/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Return true if all values match the predicate.

**Return**:

- `ok` (`boolean`): Whether the condition is met.
- `allMatch` (`boolean`): Whether the condition is met.

**Example**:

Expand All @@ -153,7 +153,7 @@ Return true if any value matches the predicate.

**Return**:

- `ok` (`boolean`): Whether the condition is met.
- `anyMatch` (`boolean`): Whether the condition is met.

**Example**:

Expand All @@ -174,7 +174,7 @@ Compare two lists using shallow element equality.

**Return**:

- `ok` (`boolean`): Whether the condition is met.
- `isEqual` (`boolean`): Whether the condition is met.

**Example**:

Expand Down Expand Up @@ -225,7 +225,7 @@ Compare two lists lexicographically.

**Return**:

- `ok` (`boolean`): Whether the condition is met.
- `isLess` (`boolean`): Whether the condition is met.

**Example**:

Expand All @@ -250,7 +250,7 @@ Compare two lists lexicographically.

**Return**:

- `ok` (`boolean`): Whether the condition is met.
- `isLessOrEqual` (`boolean`): Whether the condition is met.

**Example**:

Expand Down Expand Up @@ -392,7 +392,7 @@ Remove and return the last element.

**Return**:

- `value` (`any`): Removed value.
- `removedValue` (`any`): Removed value.

**Example**:

Expand All @@ -413,7 +413,7 @@ Remove and return the element at the given position.

**Return**:

- `value` (`any`): Removed value.
- `removedValue` (`any`): Removed value.

**Example**:

Expand Down Expand Up @@ -518,7 +518,7 @@ Return true if the list contains the value.

**Return**:

- `ok` (`boolean`): Whether the condition is met.
- `isPresent` (`boolean`): True when `v` is present in the list.

**Example**:

Expand Down Expand Up @@ -617,7 +617,7 @@ Return the first element or `nil` if empty.

**Return**:

- `value` (`any`): First value, or `nil` if empty.
- `firstValue` (`any`): First value, or `nil` if empty.

**Example**:

Expand All @@ -633,7 +633,7 @@ Return the last element or `nil` if empty.

**Return**:

- `value` (`any`): Last value, or `nil` if empty.
- `lastValue` (`any`): Last value, or `nil` if empty.

**Example**:

Expand Down Expand Up @@ -823,7 +823,7 @@ Concatenate list values using Lua's native `table.concat` behavior.

**Return**:

- `s` (`string`): Concatenated string.
- `concatenated` (`string`): Concatenated string.

**Example**:

Expand All @@ -849,7 +849,7 @@ Join list values into a string.

**Return**:

- `s` (`string`): Joined string.
- `joined` (`string`): Joined string.

**Example**:

Expand All @@ -871,7 +871,7 @@ Render the list to a string via the regular method form.

**Return**:

- `s` (`string`): Rendered list string.
- `renderedList` (`string`): Rendered list string.

**Example**:

Expand All @@ -891,7 +891,7 @@ Render list items as a table-access key path.

**Return**:

- `s` (`string`): Key-path string.
- `keyPath` (`string`): Key-path string.

**Example**:

Expand Down Expand Up @@ -958,7 +958,7 @@ Reduce the list to a single value using an accumulator.

**Return**:

- `res` (`any`): Reduced value.
- `reducedValue` (`any`): Reduced value.

**Example**:

Expand Down Expand Up @@ -1107,7 +1107,7 @@ Compare two lists using shallow element equality (`==`).

**Return**:

- `ok` (`boolean`): Whether the condition is met.
- `isEqual` (`boolean`): Whether the condition is met.

**Example**:

Expand Down Expand Up @@ -1156,7 +1156,7 @@ Compare two lists lexicographically (`<`).

**Return**:

- `ok` (`boolean`): Whether the condition is met.
- `isLess` (`boolean`): Whether the condition is met.

**Example**:

Expand All @@ -1180,7 +1180,7 @@ Compare two lists lexicographically (`<=`).

**Return**:

- `ok` (`boolean`): Whether the condition is met.
- `isLessOrEqual` (`boolean`): Whether the condition is met.

**Example**:

Expand Down Expand Up @@ -1278,7 +1278,7 @@ Render the list to a string like `{ "a", "b", 1 }`.

**Return**:

- `s` (`string`): Rendered list string.
- `renderedList` (`string`): Rendered list string.

**Example**:

Expand Down
Loading