Re: battery.el: Rename display-battery-mode to battery-mode?

[Reiner Steib <reinersteib+gmane@imap.cc>]

On Thu, Aug 04 2005, Lute Kamstra wrote:

> Reiner Steib <reinersteib+gmane@imap.cc> writes:
>
>> I tried to enable battery-mode on my notebook using `M-x battery-
>> TAB' but I got "No match".  Eventually I found
>> `display-battery-mode' in `battery.el'.  Shouldn't the name of the
>> minor mode read `battery-mode' instead of `display-battery-mode'?
>
> Agreed.

(In the meantime I saw that there's one similarly named (interactive)
command `display-time-mode'.)

>> +(define-obsolete-function-alias 'display-battery-mode 'battery-mode "22.1")
[...]
>> Okay to commit?
>
> Ok with me.
>
>> Shouldn't battery mode be mentioned briefly in (info "(emacs)Optional
>> Mode Line") as well?
>
> Maybe you can write a patch?

--8<---------------cut here---------------start------------->8---
--- display.texi	17 Jul 2005 17:48:14 +0200	1.98
+++ display.texi	04 Aug 2005 17:54:03 +0200	
@@ -890,6 +890,11 @@
 to specify the directory to check for incoming mail (any nonempty regular
 file in the directory is considered as ``newly arrived mail'').
 
+@findex battery-mode
+On some systems, Emacs can display battery status information in the
+mode line.  To enable this feature, type @kbd{M-x battery-mode} or
+customize the option @code{battery-mode}.
+
 @cindex mode line, 3D appearance
 @cindex attributes of mode line, changing
 @cindex non-integral number of lines in a window
--8<---------------cut here---------------end--------------->8---

Of course one could describe some related variables
(battery-mode-line-format, battery-update-interval, battery-load-low,
battery-load-critical), but IIRC the goal is not to add to much text
to the manual.

Does it make sense to mention `battery-status-function' in the doc
strings of `battery' and `[display-]battery-mode'?

Bye, Reiner.
-- 
       ,,,
      (o o)
---ooO-(_)-Ooo---  |  PGP key available  |  http://rsteib.home.pages.de/