GNU bug report logs - #62027
Subject: 29.0.60; Breaking change in forward-sentence/backward-sentence

Previous Next

Full log

Message #46 received at 62027-done <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: Manuel Giraud <manuel <at> ledu-giraud.fr>,
 Simen Heggestøyl <simenheg <at> runbox.com>
Cc: Eli Zaretskii <eliz <at> gnu.org>,
 "62027-done <at> debbugs.gnu.org" <62027-done <at> debbugs.gnu.org>,
 "mardani29 <at> yahoo.es" <mardani29 <at> yahoo.es>
Subject: RE: [External] : bug#62027: Subject: 29.0.60; Breaking change in
 forward-sentence/backward-sentence
Date: Wed, 8 Mar 2023 15:52:51 +0000

> > Should perhaps the return values of
> > `forward-sentence'/`backward-sentence' be documented
> > to prevent this from happening again?
> 
> Why not: Hyrum's law might have won here.  But OTOH in master,
> 'forward-sentence' is a now call to 'forward-sentence-function' that
> could be changed by the user.  Maybe should we document
> 'forward-sentence-default-function'?

Yes, but _both_ should mention the return value.
And not just "to prevent this from happening again."
Documenting this helps users use the functions.

For `forward-sentence' the doc should say that the
value of var `forward-sentence-default-function'
is called, and it returns what that function returns,
and _by default_ that is the new position (point).

Functions that have useful return values should be
documented to mention what the return value is.

Previous Next

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