GNU bug report logs - #21002
25.0.50; (elisp): `Mode Line Variables', doc of `display-time-string'

Previous Next

Full log

View this message in rfc822 format

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 21002 <at> debbugs.gnu.org
Subject: bug#21002: 25.0.50; (elisp): `Mode Line Variables', doc of `display-time-string'
Date: Sat, 30 Apr 2016 22:42:53 +0200

Drew Adams <drew.adams <at> oracle.com> writes:

> Variable `global-mode-string' is described in (elisp): `Mode Line
> Variables', including its default value.  `display-time-string' is
> mentioned explicitly.
>
> But `C-h v' tells you nothing about `display-time-string'.  To
> understand something about it you need to look at `time.el'.
>
> 1. At the least, some doc string should be added for
>    `display-time-string'.  It can, for example, refer users to command
>    `display-time' or to (emacs) `Optional Mode Line', where `display-time'
>    is covered.

I've now added a doc string that mentions `display-time'.

> 2. (elisp): `Mode Line Variables' should itself cross-reference (emacs)
>    `Optional Mode Line' or at least mention command `display-time',
>    where it mentions `display-time-string'.

And also this.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.