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

Fix documentation of network_load segment

This commit is contained in:
ZyX 2015-01-06 16:11:17 +03:00
parent 79f6853f4b
commit 983315b2c5
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
powerline/segments/common/net.py
View File

@ -268,21 +268,24 @@ falls back to reading
:file:`/sys/class/net/{interface}/statistics/{rx,tx}_bytes`. :file:`/sys/class/net/{interface}/statistics/{rx,tx}_bytes`.
:param str interface: :param str interface:
network interface to measure (use the special value "auto" to have powerline try to auto-detect the network interface) Network interface to measure (use the special value "auto" to have powerline
try to auto-detect the network interface).
:param str suffix: :param str suffix:
string appended to each load string String appended to each load string.
:param bool si_prefix: :param bool si_prefix:
use SI prefix, e.g. MB instead of MiB Use SI prefix, e.g. MB instead of MiB.
:param str recv_format: :param str recv_format:
format string, receives ``value`` as argument Format string that determines how download speed should look like. Receives
``value`` as argument.
:param str sent_format: :param str sent_format:
format string, receives ``value`` as argument Format string that determines how upload speed should look like. Receives
``value`` as argument.
:param float recv_max: :param float recv_max:
maximum number of received bytes per second. Is only used to compute Maximum number of received bytes per second. Is only used to compute
gradient level gradient level.
:param float sent_max: :param float sent_max:
maximum number of sent bytes per second. Is only used to compute gradient Maximum number of sent bytes per second. Is only used to compute gradient
level level.
Divider highlight group used: ``background:divider``. Divider highlight group used: ``background:divider``.