unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Daniel Brockman <drlion@deepwood.net>
Subject: Re: doc string of `local-variable-if-set-p'
Date: Fri, 15 Oct 2004 05:12:07 +0200	[thread overview]
Message-ID: <87d5zkn08o.fsf@wigwam.deepwood.net> (raw)
In-Reply-To: 200410150240.i9F2eQ412694@raven.dms.auburn.edu

Luc Teirlinck <teirllm@dms.auburn.edu> writes:

> Daniel Brockman wrote;
>
>    I don't see why the word ``buffer'' needs to be doubled.  The
>    following reads better and is shorter:
>
>       Non-nil if VARIABLE will be local in BUFFER when set there.
>
> BUFFER _must_ be a buffer however.  (In similar functions you can
> often also use a buffer name.  Not here.)

Ah, I didn't realize that.

Still, I think that's a detail that belongs somewhere after the
space-constrained first line.  Just doubling the word ``buffer'' isn't
going to make it clear that a buffer *name* won't do, so you might as
well spell it out clearly in the long description.

Or am I missing some long-established Emacs documentation convention?

-- 
Daniel Brockman
drlion@deepwood.net

  reply	other threads:[~2004-10-15  3:12 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2004-10-13 16:48 doc string of `local-variable-if-set-p' Masatake YAMATO
2004-10-13 17:13 ` Stefan
2004-10-13 17:22   ` Masatake YAMATO
2004-10-13 17:35     ` Stefan
2004-10-13 17:57       ` David Kastrup
2004-10-13 18:25         ` Luc Teirlinck
2004-10-13 18:23       ` Andreas Schwab
2004-10-15  0:26         ` Richard Stallman
2004-10-15  0:53           ` Miles Bader
2004-10-15  1:52           ` Luc Teirlinck
2004-10-15  2:12             ` Daniel Brockman
2004-10-15  2:40               ` Luc Teirlinck
2004-10-15  3:12                 ` Daniel Brockman [this message]
2004-10-15  4:12                   ` Luc Teirlinck
2004-10-15  5:01                     ` Daniel Brockman
2004-10-16  3:30                       ` Luc Teirlinck
2004-10-13 17:53     ` Luc Teirlinck
2004-10-13 22:24       ` Masatake YAMATO
2004-10-14  0:33         ` Luc Teirlinck
2004-10-15  0:26   ` Richard Stallman

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=87d5zkn08o.fsf@wigwam.deepwood.net \
    --to=drlion@deepwood.net \
    /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).