diff --git a/i3pystatus/cpu_usage.py b/i3pystatus/cpu_usage.py index a131850..55ffc1c 100644 --- a/i3pystatus/cpu_usage.py +++ b/i3pystatus/cpu_usage.py @@ -20,9 +20,9 @@ class CpuUsage(IntervalModule): .. rubric:: Available formatters - * {usage} usage average of all cores - * {usage_cpu*} usage of one specific core. replace "*" by core number starting at 0 - * {usage_all} usage of all cores separate. usess natsort when available(relevant for more than 10 cores) + * `{usage}` — usage average of all cores + * `{usage_cpu*}` — usage of one specific core. replace "*" by core number starting at 0 + * `{usage_all}` — usage of all cores separate. usess natsort when available(relevant for more than 10 cores) """ diff --git a/i3pystatus/cpu_usage_bar.py b/i3pystatus/cpu_usage_bar.py index f6352c8..f65aa80 100644 --- a/i3pystatus/cpu_usage_bar.py +++ b/i3pystatus/cpu_usage_bar.py @@ -15,8 +15,8 @@ class CpuUsageBar(CpuUsage, ColorRangeModule): .. rubric:: Available formatters - * {usage_bar} usage average of all cores - * {usage_bar_cpuN} usage of one specific core. replace "N" by core number starting at 0 + * `{usage_bar}` — usage average of all cores + * `{usage_bar_cpu*}` — usage of one specific core. replace "*" by core number starting at 0 """ format = "{usage_bar}" diff --git a/i3pystatus/cpu_usage_graph.py b/i3pystatus/cpu_usage_graph.py index 4776348..2de0b18 100644 --- a/i3pystatus/cpu_usage_graph.py +++ b/i3pystatus/cpu_usage_graph.py @@ -14,10 +14,10 @@ class CpuUsageGraph(CpuUsage, ColorRangeModule): .. rubric:: Available formatters - * {cpu_graph} graph of cpu usage. - * {usage} usage average of all cores - * {usage_cpu*} usage of one specific core. replace "*" by core number starting at 0 - * {usage_all} usage of all cores separate. usess natsort when available(relevant for more than 10 cores) + * `{cpu_graph}` — graph of cpu usage. + * `{usage}` — usage average of all cores + * `{usage_cpu*}` — usage of one specific core. replace "*" by core number starting at 0 + * `{usage_all}` — usage of all cores separate. usess natsort when available(relevant for more than 10 cores) """ settings = ( diff --git a/i3pystatus/github.py b/i3pystatus/github.py index 204cf37..24ed556 100644 --- a/i3pystatus/github.py +++ b/i3pystatus/github.py @@ -12,8 +12,8 @@ class Github(IntervalModule): Formatters: - * `{unread}` - contains the value of unread_marker when there are pending notifications - * `{unread_count}` - number of unread notifications, empty if 0 + * `{unread}` — contains the value of unread_marker when there are pending notifications + * `{unread_count}` — number of unread notifications, empty if 0 """ max_error_len = 50 diff --git a/i3pystatus/keyboard_locks.py b/i3pystatus/keyboard_locks.py index f77c0dd..d39378a 100644 --- a/i3pystatus/keyboard_locks.py +++ b/i3pystatus/keyboard_locks.py @@ -7,7 +7,7 @@ class Keyboard_locks(IntervalModule): """ Shows the status of CAPS LOCK, NUM LOCK and SCROLL LOCK - Available formatters: + .. rubric:: Available formatters * `{caps}` — the current status of CAPS LOCK * `{num}` — the current status of NUM LOCK @@ -17,8 +17,7 @@ class Keyboard_locks(IntervalModule): interval = 1 settings = ( - ("format", "Format string. " - "Available formaters are {core} and {usage}."), + ("format", "Format string"), ("caps_on", "String to show in {caps} when CAPS LOCK is on"), ("caps_off", "String to show in {caps} when CAPS LOCK is off"), ("num_on", "String to show in {num} when NUM LOCK is on"), diff --git a/i3pystatus/load.py b/i3pystatus/load.py index dc3f3d2..20324b7 100644 --- a/i3pystatus/load.py +++ b/i3pystatus/load.py @@ -8,12 +8,18 @@ except ImportError: class Load(IntervalModule): """ Shows system load + + .. rubric:: Available formatters + + * `{avg1}` — the load average of the last minute + * `{avg5}` — the load average of the last five minutes + * `{avg15}` — the load average of the last fifteen minutes + * `{tasks}` — the number of tasks (e.g. 1/285, which indiciates that one out of 285 total tasks is runnable) """ format = "{avg1} {avg5}" settings = ( - ("format", - "format string used for output. {avg1}, {avg5} and {avg15} are the load average of the last one, five and fifteen minutes, respectively. {tasks} is the number of tasks (i.e. 1/285, which indiciates that one out of 285 total tasks is runnable)."), + "format", ("color", "The text color"), ("critical_limit", "Limit above which the load is considered critical, defaults to amount of cores."), ("critical_color", "The critical color"), diff --git a/i3pystatus/mem.py b/i3pystatus/mem.py index d920840..dc0e018 100644 --- a/i3pystatus/mem.py +++ b/i3pystatus/mem.py @@ -29,7 +29,7 @@ class Mem(IntervalModule): settings = ( ("format", "format string used for output."), ("divisor", - "divide all byte values by this value, default 1024**2(mebibytes"), + "divide all byte values by this value, default is 1024**2 (megabytes)"), ("warn_percentage", "minimal percentage for warn state"), ("alert_percentage", "minimal percentage for alert state"), ("color", "standard color"), diff --git a/i3pystatus/mpd.py b/i3pystatus/mpd.py index 95d5bab..5e7a547 100644 --- a/i3pystatus/mpd.py +++ b/i3pystatus/mpd.py @@ -10,7 +10,7 @@ class MPD(IntervalModule): """ Displays various information from MPD (the music player daemon) - Available formatters (uses :ref:`formatp`) + .. rubric:: Available formatters (uses :ref:`formatp`) * `{title}` — (the title of the current song) * `{album}` — (the album of the current song, can be an empty string (e.g. for online streams)) diff --git a/i3pystatus/network.py b/i3pystatus/network.py index ea19208..74ad65e 100644 --- a/i3pystatus/network.py +++ b/i3pystatus/network.py @@ -221,6 +221,7 @@ class Network(IntervalModule, ColorRangeModule): .. rubric:: Available formatters Network Traffic Formatters: + * `{interface}` — the configured network interface * `{kbs}` – Float representing kb\s * `{network_graph}` – Unicode graph representing network usage @@ -230,6 +231,7 @@ class Network(IntervalModule, ColorRangeModule): * `{packets_recv}` — bytes received per second (divided by divisor) Network Information Formatters: + * `{interface}` — same as setting * `{v4}` — IPv4 address * `{v4mask}` — subnet mask @@ -240,6 +242,7 @@ class Network(IntervalModule, ColorRangeModule): * `{mac}` — MAC of interface Wireless Information Formatters: + * `{essid}` — ESSID of currently connected wifi * `{freq}` — Current frequency * `{quality}` — Link quality in percent diff --git a/i3pystatus/now_playing.py b/i3pystatus/now_playing.py index acb0784..bdb00e1 100644 --- a/i3pystatus/now_playing.py +++ b/i3pystatus/now_playing.py @@ -20,7 +20,7 @@ class NowPlaying(IntervalModule): Left click on the module play/pauses, right click goes to the next track. - Available formatters (uses :ref:`formatp`) + .. rubric:: Available formatters (uses :ref:`formatp`) * `{title}` — (the title of the current song) * `{album}` — (the album of the current song, can be an empty string (e.g. for online streams)) diff --git a/i3pystatus/pulseaudio/__init__.py b/i3pystatus/pulseaudio/__init__.py index cd1fd6a..064bf5f 100644 --- a/i3pystatus/pulseaudio/__init__.py +++ b/i3pystatus/pulseaudio/__init__.py @@ -15,7 +15,7 @@ class PulseAudio(Module, ColorRangeModule): - Requires amixer for toggling mute and incrementing/decrementing volume on scroll. - Depends on the PyPI colour module - https://pypi.python.org/pypi/colour/0.0.5 - .. rubric:: Available formatters: + .. rubric:: Available formatters * `{volume}` — volume in percent (0...100) * `{db}` — volume in decibels relative to 100 %, i.e. 100 % = 0 dB, 50 % = -18 dB, 0 % = -infinity dB diff --git a/i3pystatus/pyload.py b/i3pystatus/pyload.py index a528eab..aa41738 100644 --- a/i3pystatus/pyload.py +++ b/i3pystatus/pyload.py @@ -14,13 +14,13 @@ class pyLoad(IntervalModule): .. rubric:: Available formatters - * `{captcha}` (see captcha_true and captcha_false, which are the values filled in for this formatter) - * `{progress}` (average over all running downloads) - * `{progress_all}` (percentage of completed files/links in queue) - * `{speed}` (kilobytes/s) - * `{download}` (downloads enabled, also see download_true and download_false) - * `{total}` (number of downloads) - * `{free_space}` (free space in download directory in gigabytes) + * `{captcha}` — see captcha_true and captcha_false, which are the values filled in for this formatter + * `{progress}` — average over all running downloads + * `{progress_all}` — percentage of completed files/links in queue + * `{speed}` — kilobytes/s + * `{download}` — downloads enabled, also see download_true and download_false + * `{total}` — number of downloads + * `{free_space}` — free space in download directory in gigabytes """ interval = 5 diff --git a/i3pystatus/runwatch.py b/i3pystatus/runwatch.py index c96532c..e4eabdb 100644 --- a/i3pystatus/runwatch.py +++ b/i3pystatus/runwatch.py @@ -12,7 +12,10 @@ class RunWatch(IntervalModule): You can use this to check if a specific application, such as a VPN client or your DHCP client is running. - Available formatters are {pid} and {name}. + .. rubric:: Available formatters + + * {pid} + * {name} """ format_up = "{name}" diff --git a/i3pystatus/uname.py b/i3pystatus/uname.py index 9ce5afe..c95fa47 100644 --- a/i3pystatus/uname.py +++ b/i3pystatus/uname.py @@ -7,13 +7,13 @@ class Uname(Module): """ uname(1) like module. - Formatters: + .. rubric:: Available formatters - - {sysname}: operating system name - - {nodename}: name of machine on network (implementation-defined) - - {release}: operating system release - - {version}: operating system version - - {machine}: hardware identifier + * `{sysname}` — operating system name + * `{nodename}` — name of machine on network (implementation-defined) + * `{release}` — operating system release + * `{version}` — operating system version + * `{machine}` — hardware identifier """ format = "{sysname} {release}"