unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Stephen Berman <stephen.berman@gmx.net>
Cc: Eli Zaretskii <eliz@gnu.org>, emacs-devel@gnu.org
Subject: RE: emacs-25 f708cb2: Clarify doc string of 'transpose-sexps'
Date: Fri, 4 Nov 2016 11:00:39 -0700 (PDT)	[thread overview]
Message-ID: <83cd67b5-cb42-4fea-b6be-21e9ec8075a7@default> (raw)
In-Reply-To: <87pombceyc.fsf@gmx.net>

> > It is not unreasonable to be clear and brief.  I repeat:
> > if the doc means "the innermost sexp containing point" then
> > it should just say that.  That's not being pedantic; it's
> > being clear.
> 
> So is the following (combining Eli's changes with my correction and
> your clarification) then clear enough?
> 
...
> If the innermost sexp containing point is a list or string, you
> cannot transpose that sexp with another sexp.
...

LGTM.

But as one reader I would still want to know what "cannot"
means here - what happens if you try?  Eli has replied in the
bug thread that there are several possible behaviors (effects),
so I guess we can't usefully say what it means.  Dommage.

Here's a thought: Are any of the behaviors resulting from
trying that useful?  If so, then they should perhaps be
documented.  And if not, why don't we check for that
situation and raise an error if you try?

It is really not great to tell someone they "cannot" or
"must not" etc. do something without raising an error that
really enforces "cannot" etc.

Sure, if you try, the result won't transpose the sexps, so
technically you "cannot" transpose sexps in this case.  But
I'd sooner see a clear error than just some unpredictable
behavior.  (Unpredictable from reading the doc.  There are
multiple possibilities, and we won't be detailing them in
the doc.)



  reply	other threads:[~2016-11-04 18:00 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20161104095223.23249.72530@vcs.savannah.gnu.org>
     [not found] ` <20161104095223.631AB22012D@vcs.savannah.gnu.org>
2016-11-04 14:09   ` emacs-25 f708cb2: Clarify doc string of 'transpose-sexps' Stephen Berman
2016-11-04 14:31     ` Drew Adams
2016-11-04 15:47       ` Stephen Berman
2016-11-04 16:44         ` Drew Adams
2016-11-04 17:08           ` Stephen Berman
2016-11-04 17:21             ` Drew Adams
2016-11-04 17:50               ` Stephen Berman
2016-11-04 18:00                 ` Drew Adams [this message]
2016-11-04 18:33                   ` Eli Zaretskii
2016-11-04 18:30                 ` Eli Zaretskii
2016-11-04 18:26               ` Eli Zaretskii
2016-11-04 18:14       ` Eli Zaretskii
     [not found] <<20161104095223.23249.72530@vcs.savannah.gnu.org>
     [not found] ` <<20161104095223.631AB22012D@vcs.savannah.gnu.org>
     [not found]   ` <<8737j7e3r5.fsf@gmx.net>
     [not found]     ` <<ba4a000f-c63d-4fde-94b9-d493e895b7c7@default>
     [not found]       ` <<87y40zckn9.fsf@gmx.net>
     [not found]         ` <<977b7eaa-1c5f-4d8b-be5d-33ec73f5a962@default>
     [not found]           ` <<87twbncgve.fsf@gmx.net>
     [not found]             ` <<3687e9ab-658b-49b9-b766-8658d5c48374@default>
     [not found]               ` <<87pombceyc.fsf@gmx.net>
     [not found]                 ` <<83cd67b5-cb42-4fea-b6be-21e9ec8075a7@default>
     [not found]                   ` <<83oa1vjdrx.fsf@gnu.org>
2016-11-04 19:36                     ` Drew Adams

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=83cd67b5-cb42-4fea-b6be-21e9ec8075a7@default \
    --to=drew.adams@oracle.com \
    --cc=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=stephen.berman@gmx.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).