GNU bug report logs - #15117
24.3.50; doc of `(forward|backward)-*': state return value

Previous Next

Full log

View this message in rfc822 format

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 15117 <at> debbugs.gnu.org
Subject: bug#15117: 24.3.50; doc of `(forward|backward)-*': state return value
Date: Fri, 07 Feb 2014 21:08:19 -0800

Drew Adams <drew.adams <at> oracle.com> writes:

> These are motion functions, just like `goto-char' and
> `skip-chars-forward'.  Their doc should specify the return value
> (regardless of whether it is a position, a Boolean, always nil, or
> anything else).
>
> If, for some special (good) reason, code should not rely on the return
> value of some function then this fact should be stated explicitly in
> the doc: "This function is used only for its side effects; the return
> value is undefined."  This is Lisp, not C - return values are the norm,
> not the exception.

No, in Emacs we seldom say that.  Functions used for side effect are
quite normal.

> The doc of `(forward|backward)-(word|line)' already correctly specifies
> the return value.  Not so for other `(forward|backward)-*' functions,
> such as `(forward|backward)-sexp'.

They don't seem to return anything useful.  Closing.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.