unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 21002@debbugs.gnu.org
Subject: bug#21002: 25.0.50; (elisp): `Mode Line Variables', doc of `display-time-string'
Date: Tue, 7 Jul 2015 07:44:56 -0700 (PDT)	[thread overview]
Message-ID: <961baeef-75ba-4d8d-babe-55c1bff1d53c@default> (raw)

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.

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'.

Displaying the time in the mode-line is a user-level thing, and there
are many user options that control the resulting `display-time-string'.
The only mention of `display-time-string' in the Elisp manual should at
least point readers to information about the things that control the
content of `display-time-string', especially since most of these things
are user-level controls (e.g., options, a command).

In GNU Emacs 25.0.50.1 (i686-pc-mingw32)
 of 2014-10-20 on LEG570
Bzr revision: 118168 rgm@gnu.org-20141020195941-icp42t8ttcnud09g
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --enable-checking=yes,glyphs CPPFLAGS=-DGLYPH_DEBUG=1'





             reply	other threads:[~2015-07-07 14:44 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-07-07 14:44 Drew Adams [this message]
2016-04-30 20:42 ` bug#21002: 25.0.50; (elisp): `Mode Line Variables', doc of `display-time-string' Lars Ingebrigtsen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=961baeef-75ba-4d8d-babe-55c1bff1d53c@default \
    --to=drew.adams@oracle.com \
    --cc=21002@debbugs.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).