[doc] add scroll menu

see #921
2022-09-11 13:16:06 +02:00 · 2022-09-11 13:16:06 +02:00 · 3f97ea6a39
commit 3f97ea6a39
parent 21cbbe685d
2 changed files with 12 additions and 1 deletions
--- a/bumblebee_status/modules/core/scroll.py
+++ b/bumblebee_status/modules/core/scroll.py
@ -1,6 +1,9 @@
 # pylint: disable=C0111,R0903

-"""
+"""Displays two widgets that can be used to scroll the whole status bar
+
+Parameters:
+    * scroll.width: Width (in number of widgets) to display
 """

 import core.module
--- a/docs/modules.rst
+++ b/docs/modules.rst
@ -303,6 +303,14 @@ Parameters:

 .. image:: ../screenshots/redshift.png

+scroll
+~~~~~~
+
+Displays two widgets that can be used to scroll the whole status bar
+
+Parameters:
+    * scroll.width: Width (in number of widgets) to display
+
 sensors2
 ~~~~~~~~