unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Memnon Anon <gegendosenfleisch@googlemail.com>
To: 10057@debbugs.gnu.org
Subject: bug#10057: 24.0.91; doc string of `Info-find-file'
Date: Wed, 16 Nov 2011 18:43:53 +0000 (UTC)	[thread overview]
Message-ID: <87ty643pub.fsf@mean.albasani.net> (raw)
In-Reply-To: <8B7B45455BDC4BFBAC6E24B36D21695F@us.oracle.com>

Stefan Monnier <monnier@iro.umontreal.ca> writes:

>> You apparently want a non-nil, non-t value to implicitly be considered
>> unpredictable and unsupported ("you're on your own"), for the benefit
>> of "future compatibility", and you apparently do not want to tell
>> users that explicitly.  So be it.
>
> Saying this explicitly everywhere we rely on it would be silly.
> It's a general rule that applies to all software I know.

,----[ (info "(elisp)Documentation Tips") ]
|    * The documentation string for a variable that is a yes-or-no flag
|      should start with words such as "Non-nil means," to make it clear
!      that all non-`nil' values are equivalent and indicate explicitly
|      what `nil' and non-`nil' mean.
`----

How is this so much different?

The function checks for '(if noerror ...' , so "non-nil" matches what the
function actually does more precisely.

Future compatibility? The sentence in the docstring dates back to 2004,
for all versions since then, the test was always '(if noerror ...'.

When is this future to come?

If there were plans to differentiate 't' from other non-nil values, I 
think they got lost :). And it's not like the file is under heavy
development and an ever moving target, anyways ...

Whatever, this teeny tiny issue got way more attention than it deserved
in the first place I guess, so ... I'll stop now ;)

Memnon







  parent reply	other threads:[~2011-11-16 18:43 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-11-15 20:30 bug#10057: 24.0.91; doc string of `Info-find-file' Drew Adams
2011-11-15 21:39 ` Juri Linkov
2011-11-15 21:56   ` Drew Adams
2011-11-15 22:17     ` Andreas Schwab
2011-11-15 22:21       ` Drew Adams
2011-11-15 21:50 ` Stefan Monnier
2011-11-15 22:08   ` Drew Adams
2011-11-16  2:28     ` Stefan Monnier
2011-11-16  2:29     ` Stefan Monnier
2011-11-16  3:05       ` Drew Adams
2011-11-16  3:24         ` Glenn Morris
2011-11-16  5:23           ` Drew Adams
2011-11-16  4:22         ` Stefan Monnier
2011-11-16  5:24           ` Drew Adams
2011-11-16  8:34             ` Eli Zaretskii
2011-11-16 14:52               ` Drew Adams
2011-11-16 18:10                 ` Eli Zaretskii
2011-11-16 18:29                   ` Drew Adams
2011-11-16 18:43           ` Memnon Anon [this message]
2011-11-16 19:56             ` Eli Zaretskii
2011-11-16 17:03         ` Juri Linkov
2011-11-16 18:29           ` Drew Adams
2011-11-16 19:31             ` Juri Linkov
2011-11-16 20:04               ` Drew Adams
2011-11-16 20:28                 ` Juri Linkov

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=87ty643pub.fsf@mean.albasani.net \
    --to=gegendosenfleisch@googlemail.com \
    --cc=10057@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).