Skip to content

Commit aea1716

Browse files
haithiumgithub-actions[bot]
authored andcommitted
chore(docs): auto-generate docs
1 parent 633f3e6 commit aea1716

16 files changed

Lines changed: 884 additions & 85 deletions

File tree

docs/src/modules/is.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
desc: "Type predicates for Lua values and filesystem path kinds."
2+
description: "Type predicates for Lua values and filesystem path types."
33
---
44

55
# `is`
66

7-
Type predicates for Lua values and filesystem path kinds.
7+
Type predicates for Lua values and filesystem path types.
88

99
## Usage
1010

@@ -65,16 +65,16 @@ is("hello", "STRING") --> true
6565

6666
**Path Checks**:
6767

68-
| Function | Description |
69-
| ------------------------- | ------------------------------------------------------- |
70-
| [`block(v)`](#fn-block) | Returns `true` when `v` is a block device path. |
71-
| [`char(v)`](#fn-char) | Returns `true` when `v` is a char device path. |
72-
| [`device(v)`](#fn-device) | Returns `true` when `v` is a block or char device path. |
73-
| [`dir(v)`](#fn-dir) | Returns `true` when `v` is a directory path. |
74-
| [`fifo(v)`](#fn-fifo) | Returns `true` when `v` is a FIFO path. |
75-
| [`file(v)`](#fn-file) | Returns `true` when `v` is a file path. |
76-
| [`link(v)`](#fn-link) | Returns `true` when `v` is a symlink path. |
77-
| [`socket(v)`](#fn-socket) | Returns `true` when `v` is a socket path. |
68+
| Function | Description |
69+
| ------------------------- | ------------------------------------------------------------ |
70+
| [`block(v)`](#fn-block) | Returns `true` when `v` is a block device path. |
71+
| [`char(v)`](#fn-char) | Returns `true` when `v` is a character device path. |
72+
| [`device(v)`](#fn-device) | Returns `true` when `v` is a block or character device path. |
73+
| [`dir(v)`](#fn-dir) | Returns `true` when `v` is a directory path. |
74+
| [`fifo(v)`](#fn-fifo) | Returns `true` when `v` is a FIFO path. |
75+
| [`file(v)`](#fn-file) | Returns `true` when `v` is a file path. |
76+
| [`link(v)`](#fn-link) | Returns `true` when `v` is a symlink path. |
77+
| [`socket(v)`](#fn-socket) | Returns `true` when `v` is a socket path. |
7878

7979
### Type Checks
8080

@@ -362,13 +362,13 @@ is.truthy("non-empty")
362362

363363
### Path Checks
364364

365-
Filesystem path kind checks.
365+
Filesystem path type checks.
366366

367367
> [!IMPORTANT]
368368
>
369369
> Path checks require **LuaFileSystem**
370-
> ([`lfs`](https://github.com/lunarmodules/luafilesystem)) and raise an error it
371-
> is not installed. <a id="fn-block"></a>
370+
> ([`lfs`](https://github.com/lunarmodules/luafilesystem)) and raise an error if
371+
> it is not installed. <a id="fn-block"></a>
372372
373373
#### `block(v)`
374374

@@ -392,7 +392,7 @@ is.block("/dev/sda")
392392

393393
#### `char(v)`
394394

395-
Returns `true` when `v` is a char device path.
395+
Returns `true` when `v` is a character device path.
396396

397397
**Parameters**:
398398

@@ -412,7 +412,7 @@ is.char("/dev/null")
412412

413413
#### `device(v)`
414414

415-
Returns `true` when `v` is a block or char device path.
415+
Returns `true` when `v` is a block or character device path.
416416

417417
**Parameters**:
418418

docs/src/modules/keyword.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
desc: "Lua keyword helpers."
2+
description: "Lua keyword helpers."
33
---
44

55
# `keyword`
@@ -17,13 +17,13 @@ kw.isidentifier("hello_world") --> true
1717

1818
## Functions
1919

20-
| Function | Description |
21-
| ----------------------------------------------------- | ----------------------------------------------------------------------------------- |
22-
| [`iskeyword(v)`](#fn-iskeyword) | Return `true` when `v` is a reserved Lua keyword. |
23-
| [`isidentifier(v)`](#fn-isidentifier) | Return `true` when `v` is a valid non-keyword Lua identifier. |
24-
| [`kwlist()`](#fn-kwlist) | Return Lua keywords as a [`mods.List`](https://luamod.github.io/mods/modules/list). |
25-
| [`kwset()`](#fn-kwset) | Return Lua keywords as a [`mods.Set`](https://luamod.github.io/mods/modules/set). |
26-
| [`normalize_identifier(s)`](#fn-normalize-identifier) | Normalize an input into a safe Lua identifier. |
20+
| Function | Description |
21+
| ----------------------------------------------------- | ------------------------------------------------------------- |
22+
| [`iskeyword(v)`](#fn-iskeyword) | Return `true` when `v` is a reserved Lua keyword. |
23+
| [`isidentifier(v)`](#fn-isidentifier) | Return `true` when `v` is a valid non-keyword Lua identifier. |
24+
| [`kwlist()`](#fn-kwlist) | Return Lua keywords as a [`mods.List`](/modules/list). |
25+
| [`kwset()`](#fn-kwset) | Return Lua keywords as a [`mods.Set`](/modules/set). |
26+
| [`normalize_identifier(s)`](#fn-normalize-identifier) | Normalize an input into a safe Lua identifier. |
2727

2828
<a id="fn-iskeyword"></a>
2929

@@ -71,8 +71,7 @@ kw.isidentifier("local") --> false
7171

7272
### `kwlist()`
7373

74-
Return Lua keywords as a
75-
[`mods.List`](https://luamod.github.io/mods/modules/list).
74+
Return Lua keywords as a [`mods.List`](/modules/list).
7675

7776
**Return**:
7877

@@ -88,8 +87,7 @@ kw.kwlist():contains("and") --> true
8887

8988
### `kwset()`
9089

91-
Return Lua keywords as a
92-
[`mods.Set`](https://luamod.github.io/mods/modules/set).
90+
Return Lua keywords as a [`mods.Set`](/modules/set).
9391

9492
**Return**:
9593

docs/src/modules/list.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
desc:
2+
description:
33
"A list class providing common operations to create, modify, and query
44
sequences of values."
55
---

0 commit comments

Comments
 (0)