diff options
| author | jacqueline <me@jacqueline.id.au> | 2024-03-07 17:22:06 +1100 |
|---|---|---|
| committer | jacqueline <me@jacqueline.id.au> | 2024-03-07 17:22:06 +1100 |
| commit | 36a19182bec171d6376e51f5689aaf70b9d6fbad (patch) | |
| tree | b75be5f1567510ce2c60693c978a6ddf0b879905 /luals-stubs/power.lua | |
| parent | beb1f654958c28429323fcb9622c9c8d206979a3 (diff) | |
| download | tangara-fw-36a19182bec171d6376e51f5689aaf70b9d6fbad.tar.gz | |
Use luals-stubs as the source of truth for docs, instead of maintaining
separate docs stubs
Includes introducing a cool new script to turn lua-language-server's
json output into markdown documentation.
Diffstat (limited to 'luals-stubs/power.lua')
| -rw-r--r-- | luals-stubs/power.lua | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/luals-stubs/power.lua b/luals-stubs/power.lua index 226f8200..ac7f15bb 100644 --- a/luals-stubs/power.lua +++ b/luals-stubs/power.lua @@ -1,6 +1,7 @@ --- @meta ---- Properties and functions that deal with the device's battery and power state. +--- The `power` module contains properties and functions that relate to the +--- device's battery and charging state. --- @class power --- @field battery_pct Property The battery's current charge, as a percentage of the maximum charge. --- @field battery_millivolts Property The battery's current voltage, in millivolts. |