From 983315b2c5cb58f7c69ead0d1b8c275ea9098e78 Mon Sep 17 00:00:00 2001 From: ZyX Date: Tue, 6 Jan 2015 16:11:17 +0300 Subject: [PATCH] Fix documentation of network_load segment --- powerline/segments/common/net.py | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/powerline/segments/common/net.py b/powerline/segments/common/net.py index 0534a869..46a294db 100644 --- a/powerline/segments/common/net.py +++ b/powerline/segments/common/net.py @@ -268,21 +268,24 @@ falls back to reading :file:`/sys/class/net/{interface}/statistics/{rx,tx}_bytes`. :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: - string appended to each load string + String appended to each load string. :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: - format string, receives ``value`` as argument + Format string that determines how download speed should look like. Receives + ``value`` as argument. :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: - maximum number of received bytes per second. Is only used to compute - gradient level + Maximum number of received bytes per second. Is only used to compute + gradient level. :param float sent_max: - maximum number of sent bytes per second. Is only used to compute gradient - level + Maximum number of sent bytes per second. Is only used to compute gradient + level. Divider highlight group used: ``background:divider``.