unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 15117@debbugs.gnu.org, lekktu@gmail.com, larsi@gnus.org
Subject: bug#15117: 24.3.50; doc of `(forward|backward)-*': state return value
Date: Tue, 11 Feb 2014 09:29:24 -0800 (PST)	[thread overview]
Message-ID: <67b917ca-8b69-49fd-9e12-68da310f7567@default> (raw)
In-Reply-To: <8361oltxu1.fsf@gnu.org>

> If you (Drew) want that something productive comes out of this,
> please point out specific forward/backward-* functions that return
> non-trivial values, and those values are not documented.  The only 2
> functions mentioned since the beginning of this discussion are
> forward/backward-sexp, which always return nil, a.k.a. "nothing".  I
> also tried a couple of other random functions, and they seem all to
> be of this "nothing" kind.  So I wonder whether we have any real
> problem here.

I would like to see functions that are purely motion functions
return `point', the destination position, unless there is a more
useful return value (as is already the case for a function such as
`forward-comment' or `forward-button').

IOW, some useful value is better than none.  Note: I have nothing
against picking a _more_ useful value than `point'.  Point is just
a default suggestion.  For an example of a more useful value, see
`forward-comment': it sets `point' but returns t or nil.

And document that return value.  Here are some candidates, for a
start (likewise, their backward relatives, and other relatives,
such as `up-list', `down-list', `backward-up-list'...).

forward-char
forward-list ; already returns `point'
forward-page ; returns count
forward-same-syntax
forward-sentence
forward-sexp
forward-symbol
forward-thing
forward-to-indentation
forward-visible-line
forward-whitespace
forward-word

We can look for other motion functions to treat similarly after
this start.  Assuming there is any will to do this.





  reply	other threads:[~2014-02-11 17:29 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-08-17 15:59 bug#15117: 24.3.50; doc of `(forward|backward)-*': state return value Drew Adams
2014-02-08  5:08 ` Lars Ingebrigtsen
2014-02-10  0:12   ` Drew Adams
2014-02-10  2:39     ` Lars Ingebrigtsen
2014-02-10  2:45       ` Drew Adams
2014-02-10 16:27     ` Stefan Monnier
2014-02-10 21:16       ` Drew Adams
2014-02-11  1:07         ` Dmitry Gutov
2014-02-11  6:40           ` Drew Adams
2014-02-11  1:28         ` Juanma Barranquero
2014-02-11  6:43           ` Drew Adams
2014-02-11 16:31             ` Eli Zaretskii
2014-02-11 17:29               ` Drew Adams [this message]
2014-02-11 18:05                 ` Eli Zaretskii
2014-02-11 18:42                 ` Andreas Röhler
2014-02-11 18:58                   ` Eli Zaretskii
2014-02-11 19:13                     ` Drew Adams
2014-02-11 19:26                     ` Andreas Röhler
2014-02-11 17:36             ` Juanma Barranquero
2014-02-11  2:52         ` Glenn Morris
2014-02-11  4:01         ` Stefan Monnier
2014-02-11 10:52           ` Andreas Röhler
2014-02-11 11:16             ` Nicolas Richard
2014-02-11 12:10               ` Andreas Röhler
     [not found] <<1dc76f7a-5481-41df-b976-ec22229d7283@default>
     [not found] ` <<874n4a42f0.fsf@building.gnus.org>
     [not found]   ` <<1281d0fd-77cb-45e2-b99d-f4ad24b0fc4e@default>
     [not found]     ` <<jwvr47b3pcw.fsf-monnier+emacsbugs@gnu.org>
     [not found]       ` <<2fefcbaf-9417-4f57-93af-490ea73aea98@default>
     [not found]         ` <<CAAeL0SRYdnYryaVzADc5L61vgM0EPQeBzG2h327YynitS18tXA@mail.gmail.com>
     [not found]           ` <<68a64949-d801-4d09-8dc8-4b6ae0824855@default>
     [not found]             ` <<8361oltxu1.fsf@gnu.org>
     [not found]               ` <<67b917ca-8b69-49fd-9e12-68da310f7567@default>
     [not found]                 ` <<8338jpttic.fsf@gnu.org>
2014-02-11 18:14                   ` Drew Adams
2014-02-11 18:17                     ` Eli Zaretskii
     [not found]                   ` <<5889df4e-4343-4136-ae49-4062659da625@default>
     [not found]                     ` <<831tz9tsy2.fsf@gnu.org>
2014-02-11 18:26                       ` 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=67b917ca-8b69-49fd-9e12-68da310f7567@default \
    --to=drew.adams@oracle.com \
    --cc=15117@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    --cc=larsi@gnus.org \
    --cc=lekktu@gmail.com \
    /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).