doc: cpu: ‘interval’ has been renamed to ‘poll-interval’

Closes #241
This commit is contained in:
Daniel Eklöf 2022-12-18 10:36:01 +01:00
parent 710cede371
commit 252a7a1580
No known key found for this signature in database
GPG key ID: 5BBD4992C116573F
2 changed files with 6 additions and 3 deletions

View file

@ -19,8 +19,11 @@
* Build failures for certain combinations of enabled and disabled * Build failures for certain combinations of enabled and disabled
plugins ([#239][239]). plugins ([#239][239]).
* Documentation for the `cpu` module; `interval` has been renamed to
`poll-interval` ([#241][241]).
[239]: https://codeberg.org/dnkl/yambar/issues/239 [239]: https://codeberg.org/dnkl/yambar/issues/239
[241]: https://codeberg.org/dnkl/yambar/issues/241
### Security ### Security

View file

@ -28,7 +28,7 @@ total CPU usage.
:[ *Type* :[ *Type*
:[ *Req* :[ *Req*
:< *Description* :< *Description*
| interval | poll-interval
: int : int
: no : no
: Refresh interval of the CPU usage stats in ms (default=500). Cannot : Refresh interval of the CPU usage stats in ms (default=500). Cannot
@ -41,7 +41,7 @@ total CPU usage.
bar: bar:
left: left:
- cpu: - cpu:
interval: 2500 poll-interval: 2500
content: content:
map: map:
conditions: conditions:
@ -55,7 +55,7 @@ bar:
bar: bar:
left: left:
- cpu: - cpu:
interval: 2500 poll-interval: 2500
content: content:
map: map:
conditions: conditions: