From a0b2239002d0730171c9904bd93b84447e3eb466 Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Fri, 3 Jun 2022 15:04:42 +0300 Subject: [PATCH] ; Improve documentation of 'battery-update-functions' * lisp/battery.el (battery-update-functions) (display-battery-mode): Improve wording of doc strings. (Bug#55770) --- lisp/battery.el | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/lisp/battery.el b/lisp/battery.el index cd68d7601f9..3cff3167a6c 100644 --- a/lisp/battery.el +++ b/lisp/battery.el @@ -234,11 +234,11 @@ The text being displayed in the echo area is controlled by the variables (defcustom battery-update-functions nil "Functions run by `display-battery-mode' after updating the status. -These functions will be called with one parameter: An alist that -contains data about the current battery status. The key in the -alist is a character, and the values in the alist are strings. -Different battery backends deliver different information, so the -following information may or may not be available: +These functions will be called with one parameter, an alist that +contains data about the current battery status. The keys in the +alist are single characters and the values are strings. +Different battery backends deliver different information, so some +of the following information may or may not be available: v: driver-version V: bios-version @@ -275,9 +275,9 @@ The text displayed in the mode line is controlled by The mode line is be updated every `battery-update-interval' seconds. -The update function will call the functions in -`battery-update-functions', which can be used to trigger actions -based on battery events." +The function which updates the mode-line display will call the +functions in `battery-update-functions', which can be used to +trigger actions based on battery-related events." :global t (setq battery-mode-line-string "") (or global-mode-string (setq global-mode-string '(""))) -- 2.39.2