Skip to content

Commit 2531e25

Browse files
committed
docs(quickstart): integrate type links into text
1 parent 2c71e9a commit 2531e25

1 file changed

Lines changed: 6 additions & 14 deletions

File tree

docs/tutorials/quickstart.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,15 @@ attaches them as `id_aliases` and `path_aliases` fields.
2525

2626
## Inspect a device
2727

28-
If you know the path, inspect one device directly:
28+
If you know the path, inspect one device directly to get its
29+
[`evdev.deviceInfo`]:
2930

3031
```lua
3132
local path = "/dev/input/event1"
3233
local dev = assert(evdev.devices.device_info(path))
3334
print(dev.name)
3435
```
3536

36-
::: details Device info
37-
38-
<!-- @include: ../reference/device-info.md -->
39-
40-
:::
41-
4237
## Find devices by `name` or `path`
4338

4439
Search for a device by its name or `/dev/input/` path:
@@ -93,11 +88,8 @@ for e in dev:events() do
9388
end
9489
```
9590

96-
The iterator polls and reads in a loop, yielding each event as it arrives. It
97-
runs until the device is closed or an error occurs.
91+
The iterator polls and reads in a loop, yielding each [`evdev.event`] as it
92+
arrives. It runs until the device is closed or an error occurs.
9893

99-
::: details Event fields
100-
101-
<!-- @include: ../reference/event-fields.md -->
102-
103-
:::
94+
[`evdev.deviceInfo`]: ../types#evdev-deviceinfo
95+
[`evdev.event`]: ../types#evdev-event

0 commit comments

Comments
 (0)