docs: fix typos and improve language coherence

This commit is contained in:
Avishek Sen
2023-10-21 21:15:25 +05:30
parent dbb887b4a9
commit d0cab2a367
37 changed files with 144 additions and 144 deletions

View File

@ -34,14 +34,14 @@ Addressed by *custom/<name>*
typeof: integer ++
The interval (in seconds) in which the information gets polled. ++
Use *once* if you want to execute the module only on startup. ++
You can update it manually with a signal. If no *interval* or *signal* is defined, it is assumed that the out script loops it self. ++
If a *signal* is defined then the script will run once on startup and will will only update with a signal.
You can update it manually with a signal. If no *interval* or *signal* is defined, it is assumed that the out script loops itself. ++
If a *signal* is defined then the script will run once on startup and will only update with a signal.
*restart-interval*: ++
typeof: integer ++
The restart interval (in seconds). ++
Can't be used with the *interval* option, so only with continuous scripts. ++
Once the script exit, it'll be re-executed after the *restart-interval*.
Once the script exits, it'll be re-executed after the *restart-interval*.
*signal*: ++
typeof: integer ++
@ -68,7 +68,7 @@ Addressed by *custom/<name>*
*min-length*: ++
typeof: integer ++
The minimum length in characters the module should take up.
The minimum length in characters the module should accept.
*align*: ++
typeof: float ++
@ -84,7 +84,7 @@ Addressed by *custom/<name>*
*on-click-right*: ++
typeof: string ++
Command to execute when you right clicked on the module.
Command to execute when you right-click on the module.
*on-update*: ++
typeof: string ++
@ -136,7 +136,7 @@ $text\\n$tooltip\\n$class*
*{}*: Output of the script.
*{percentage}* Percentage which can be set via a json return-type.
*{percentage}* Percentage which can be set via a json return type.
*{icon}*: An icon from 'format-icons' according to percentage.