unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: <emacs-devel@gnu.org>
Subject: RE: typo in accept-process-output (process.c)
Date: Tue, 7 Aug 2007 16:16:51 -0700	[thread overview]
Message-ID: <BNELLINCGFJLDJIKDGACEEEKCBAA.drew.adams@oracle.com> (raw)
In-Reply-To: <46B8EF72.4090903@gmail.com>

> Just a thought: Is there any other (non-math and non-logical) software
> that uses iff in the documentation?

Of course. (Some of the results of googling `iff software documentation' are
examples.)

Also, the Emacs user community includes mostly developers so far, and many
of them produce software, specs, and documentation that are aimed at other
developers. My guess is that many (most?) Emacs users will already be
familiar with "iff", but I could be wrong about that.

On the other hand, I see no special reason to use "iff" when "if and only
if" can be used instead. It could argued that "iff" can be handy for the
first line of a doc string, where space is at a premium, but in most cases
such rigor is not needed in that first line. And of course there is no
hyperlinked glossary for doc strings (either).

Overall, I'd say we don't need to use "iff". In any case, we should not
substitute "if" for "if and only if" in contexts where the distinction is
important.

If we had glossary links with visual cues, then it could be OK to use "iff",
but I see no real reason not to always use "if and only if" instead.

It can be OK to use just "if" informally, at first (say in a doc string
first line), provided that the rest of the text tells the whole truth, and
provided that doing so improves readability (e.g. by sounding less formal).

Rules of thumb:

1. Use "if A then B" or "A implies B" for implication. These are generally
clearer to readers than the equivalents "B if A" and "A only if B".

2. Use "if and only if" for logical equivalence, not "if".

(Even though "A if B" and "A only if B" can confuse readers about the
direction, there is no such problem when both directions are meant.)

  reply	other threads:[~2007-08-07 23:16 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-08-05 12:04 typo in accept-process-output (process.c) Dieter Wilhelm
2007-08-05 12:21 ` David Kastrup
2007-08-05 20:01   ` Glenn Morris
2007-08-05 22:54     ` Dieter Wilhelm
2007-08-06  0:06       ` Nick Roberts
2007-08-06  6:41         ` Dieter Wilhelm
2007-08-06 14:19     ` Richard Stallman
2007-08-06 20:50       ` Michael Olson
2007-08-07 11:02         ` Stephen Berman
2007-08-07 11:18           ` David Kastrup
2007-08-07 11:31         ` Jason Rumney
2007-08-07 16:37           ` Stefan Monnier
2007-08-07 17:33             ` Drew Adams
2007-08-07 22:01               ` Dieter Wilhelm
2007-08-07 22:17                 ` Lennart Borgman (gmail)
2007-08-07 23:16                   ` Drew Adams [this message]
2007-08-08  0:06                     ` Jason Rumney
2007-08-08  0:21                       ` Drew Adams
2007-08-09  0:07                   ` Richard Stallman
2007-08-08  3:06                 ` Eli Zaretskii
2007-08-08  5:50                   ` Dieter Wilhelm
2007-08-08 18:43                     ` Eli Zaretskii
2007-08-08 20:14                       ` David Kastrup
2007-08-08 20:24                       ` Stefan Monnier
2007-08-08 20:27                         ` martin rudalics
2007-08-08 20:53                           ` Stefan Monnier
2007-08-12 20:33                       ` Christian Schlauer
2007-08-12 22:01                         ` Stephen Berman
2007-08-13  5:00                         ` Richard Stallman
2007-08-05 20:54   ` Richard Stallman
2007-08-08  7:54     ` Glenn Morris
2007-08-09  0:07       ` 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=BNELLINCGFJLDJIKDGACEEEKCBAA.drew.adams@oracle.com \
    --to=drew.adams@oracle.com \
    --cc=emacs-devel@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).