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

[Eli Zaretskii]

> From: Drew Adams <drew.adams@oracle.com>
> CC: Eli Zaretskii <eliz@gnu.org>,
>         "62027-done@debbugs.gnu.org"
>       <62027-done@debbugs.gnu.org>,
>         "mardani29@yahoo.es" <mardani29@yahoo.es>
> 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.

Not when the value is a simple consequence of the implementation, no.

forward-sentence does its job by side effect, not by the value it
returns.