From a3759eb8a422e132f3e6e48723b7725130a7ee1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nguy=E1=BB=85n=20Gia=20Phong?= Date: Thu, 14 Feb 2019 20:32:55 +0700 Subject: [PATCH] Nitpick documentation for 2.3.2 release --- Changes.md | 21 +++++++++++++++++++++ README.md | 17 +++++++++-------- 2 files changed, 30 insertions(+), 8 deletions(-) diff --git a/Changes.md b/Changes.md index 2794add..4958841 100644 --- a/Changes.md +++ b/Changes.md @@ -1,3 +1,24 @@ +# Changes in 2.3.2 + +Features: + +- Support stacked graphs +- [hwmontemp\_linux] Provide name-based access to hwmon sensors via sysfs +- [mpd\_all] Expose more informations and format time in [hh:]mm:ss + +Fixes: + +- Improve defaults and mechanism for data caching +- Escape XML entities in results by default +- [weather\_all] Update NOAA link and use Awesome asynchronous API +- [mem\_linux] Use MemAvailable to calculate free amount +- [mem\_freebsd] Correct calculation and switch to swapinfo for swap +- [bat\_freebsd] Add critical charging state +- [fs\_all] Fix shell quoting of option arguments + +Moreover, `.luacheckrc` was added and `README.md` was refomatted for the ease +of development. + # Changes in 2.3.1 Fixes: diff --git a/README.md b/README.md index 3f498b6..cbded56 100644 --- a/README.md +++ b/README.md @@ -155,7 +155,9 @@ Supported platforms: GNU/Linux (require `sysfs`), FreeBSD (require `acpiconf`). ### vicious.widgets.cpu -Provides CPU usage for all available CPUs/cores. +Provides CPU usage for all available CPUs/cores. Since this widget type give +CPU utilization between two consecutive calls, it is recommended to enable +caching if it is used to register multiple widgets (#71). Supported platforms: GNU/Linux, FreeBSD. @@ -270,15 +272,14 @@ Provides name-based access to hwmon devices via sysfs. Supported platforms: GNU/Linux -* Argument: table with sensor name and (optional) input number, e.g. - `{ "radeon", 2 }` (input no. is assumed to be 1 if omitted) +* Argument: an array with sensor name and input number (optional, falling back + to `1`), e.g. `{"radeon", 2}` * Returns a table with just the temperature value: `$1` * Usage example: - -```lua -gputemp = wibox.widget.textbox() -vicious.register(gputemp, vicious.contrib.hwmontemp, " $1°C", 5, { "radeon" }) -``` + ```lua + gputemp = wibox.widget.textbox() + vicious.register(gputemp, vicious.widgets.hwmontemp, " $1°C", 5, {"radeon"}) + ``` ### vicious.widgets.mbox