From b9a30ae23508f302a431364964184d24bddabf19 Mon Sep 17 00:00:00 2001 From: tobi-wan-kenobi Date: Fri, 29 May 2020 11:12:40 +0200 Subject: [PATCH] [doc] update module doc --- docs/modules.rst | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/modules.rst b/docs/modules.rst index df78637..a99c452 100644 --- a/docs/modules.rst +++ b/docs/modules.rst @@ -281,13 +281,16 @@ contrib amixer ~~~~~~ -get volume level +get volume level or control it Parameters: - * amixer.device: Device to use, defaults to "Master,0" + * amixer.device: Device to use (default is Master,0) + * amixer.percent_change: How much to change volume by when scrolling on the module (default is 4%) contributed by `zetxx `_ - many thanks! +input handling contributed by `ardadem _ - many thanks! + .. image:: ../screenshots/amixer.png apt @@ -636,7 +639,9 @@ contributed by `Ryunaq `_ - many thanks! github ~~~~~~ -Displays the unread GitHub notifications for a GitHub user +Displays the unread GitHub notifications count for a GitHub user using the following reasons: + + * https://developer.github.com/v3/activity/notifications/#notification-reasons Requires the following library: * requests @@ -644,8 +649,11 @@ Requires the following library: Parameters: * github.token: GitHub user access token, the token needs to have the 'notifications' scope. * github.interval: Interval in minutes between updates, default is 5. + * github.reasons: Comma separated reasons to be parsed (e.g.: github.reasons=mention,team_mention,review_requested) -contributed by `yvesh `_ - many thanks! +contributed by: + * v1 - `yvesh `_ - many thanks! + * v2 - `cristianmiranda `_ - many thanks! .. image:: ../screenshots/github.png