GNU bug report logs - #31135
26.1; documentation of left-word and right-word are unclear

Previous Next

Full log

View this message in rfc822 format

From: Eli Zaretskii <eliz <at> gnu.org>
To: Robert Pluim <rpluim <at> gmail.com>
Cc: 31135 <at> debbugs.gnu.org
Subject: bug#31135: 26.1; documentation of left-word and right-word are unclear
Date: Thu, 12 Apr 2018 19:51:10 +0300

> From: Robert Pluim <rpluim <at> gmail.com>
> Date: Thu, 12 Apr 2018 18:21:37 +0200
> 
> The documentation strings for left-word and right-word both say:
> 
>   Value is normally t.
>   If an edge of the buffer or a field boundary is reached, point is left there
>   there and the function returns nil.  Field boundaries are not noticed
> 
> 
> 1. Which value is normally t?

This is standard Emacs parlance: left-word is a function, and
functions generally return values in Lisp.  So when we say "value is"
in the doc string of a function, we mean the value returned by that
function.

> 2. 'there' is repeated in the second sentence.

This kind of stuff needs to be fixed, no need to report it.

Thanks.

Previous Next

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