tyler.durden
/
powerline
mirror of https://github.com/powerline/powerline.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update battery segment docstring

This commit is contained in:
Foo 2015-08-08 01:15:05 +03:00
parent d02b8e9825
commit 63a8b492b3
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
powerline/segments/common/bat.py
View File

@ -184,14 +184,19 @@ def battery(pl, format='{ac_state} {capacity:3.0%}', steps=5, gamify=False, full
'''Return battery charge status.
:param str format:
Percent format in case gamify is False.
Percent format in case gamify is False. Format arguments: ``ac_state``
which is equal to either ``online`` or ``offline`` string arguments and
``capacity`` which is equal to current battery capacity in interval [0,
100].
:param int steps:
Number of discrete steps to show between 0% and 100% capacity if gamify
is True.
:param bool gamify:
Measure in hearts (♥) instead of percentages. For full hearts
``battery_full`` highlighting group is preferred, for empty hearts there
is ``battery_empty``.
is ``battery_empty``. ``battery_online`` or ``battery_offline`` group
will be used for leading segment containing ``online`` or ``offline``
argument contents.
:param str full_heart:
Heart displayed for “full” part of battery.
:param str empty_heart:
@ -200,9 +205,9 @@ def battery(pl, format='{ac_state} {capacity:3.0%}', steps=5, gamify=False, full
the same as full_heart as long as necessary highlighting groups are
defined.
:param str online:
If computer is connected to a power supply this symbol is prepended to the segment.
Symbol used if computer is connected to a power supply.
:param str offline:
If computer is NOT connected to a power supply this symbol is prepended to the segment.
Symbol used if computer is not connected to a power supply.
``battery_gradient`` and ``battery`` groups are used in any case, first is
preferred.