unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: 12059@debbugs.gnu.org
Subject: bug#12059: 24.1; undefined term "alternate display form" in of `format' doc string
Date: Thu, 26 Jul 2012 09:09:02 -0700	[thread overview]
Message-ID: <5412BFCEE45F4ED0AC9E2D73676750FC@us.oracle.com> (raw)

The description of `#' in the doc string is useless.  It just refers
to a mysterious "alternate display form" without saying anything about
what that is.
 
Either add that information (see the Elisp manual for it) or get rid of
any (pseudo) explanation of `#' and just point to node (elisp)
`Formatting Strings'.
 
IOW, either actually describe `#' or punt to the manual.  But please do
not give the impression that this explains something where it does not.
That misleads readers into thinking that they have been told what it is
and wondering why they do not understand.

In GNU Emacs 24.1.1 (i386-mingw-nt5.1.2600)
 of 2012-06-10 on MARVIN
Windowing system distributor `Microsoft Corp.', version 5.1.2600
Configured using:
 `configure --with-gcc (4.6) --cflags
 -ID:/devel/emacs/libs/libXpm-3.5.8/include
 -ID:/devel/emacs/libs/libXpm-3.5.8/src
 -ID:/devel/emacs/libs/libpng-dev_1.4.3-1/include
 -ID:/devel/emacs/libs/zlib-dev_1.2.5-2/include
 -ID:/devel/emacs/libs/giflib-4.1.4-1/include
 -ID:/devel/emacs/libs/jpeg-6b-4/include
 -ID:/devel/emacs/libs/tiff-3.8.2-1/include
 -ID:/devel/emacs/libs/gnutls-3.0.9/include'
 






             reply	other threads:[~2012-07-26 16:09 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-07-26 16:09 Drew Adams [this message]
2012-08-14 16:21 ` bug#12059: 24.1; undefined term "alternate display form" in of `format' doc string Chong Yidong

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=5412BFCEE45F4ED0AC9E2D73676750FC@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=12059@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).