[gnu.emacs.bug] incorrect documentation for subst-char-in-region

sboisen@REGULUS.BBN.COM (Sean Boisen) (12/06/88)

Under my version of GNU Emacs (18.49.5), the documentation for
subst-char-in-region reads as follows:

subst-char-in-region:
From START to END, replace FROMCHAR with TOCHAR each time it occurs.
If optional arg NOUNDO is non-nil, don't record this change for undo
and don't mark the buffer as really changed.

However, the description of the NOUNDO arg is incorrect: the following
call 

(subst-char-in-region (point) (mark) ?\n ?\r 'noundo)

intending to hide a region of text, DOES mark the buffer as modified
(although it doesn't, as stated, record the change for undo). Is this
an error in the documentation or in the function?

Sean Boisen

........................................
Sean Boisen -- sboisen@bbn.com
BBN Systems and Technologies Corporation, Cambridge MA
Disclaimer: these opinions void where prohibited by lawyers.