diff --git a/CHANGELOG.md b/CHANGELOG.md index ae97a0a..3c243d0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,8 +19,11 @@ * Build failures for certain combinations of enabled and disabled 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 +[241]: https://codeberg.org/dnkl/yambar/issues/241 ### Security diff --git a/doc/yambar-modules-cpu.5.scd b/doc/yambar-modules-cpu.5.scd index 1b4219e..bfd9357 100644 --- a/doc/yambar-modules-cpu.5.scd +++ b/doc/yambar-modules-cpu.5.scd @@ -28,7 +28,7 @@ total CPU usage. :[ *Type* :[ *Req* :< *Description* -| interval +| poll-interval : int : no : Refresh interval of the CPU usage stats in ms (default=500). Cannot @@ -41,7 +41,7 @@ total CPU usage. bar: left: - cpu: - interval: 2500 + poll-interval: 2500 content: map: conditions: @@ -55,7 +55,7 @@ bar: bar: left: - cpu: - interval: 2500 + poll-interval: 2500 content: map: conditions: