Re: literal newlines in @result{} strings

[Juri Linkov <juri@jurta.org>]

> for `thing-at-point' i see:
>
>      @result{} "Gentlemen may cry ``Peace! Peace!,''\n"
>
> which has the `\n' instead of a literal newline.  i'd like to change the
> former two to resemble the latter.  any objections?  any reason to go in
> the opposite direction?

Neither of these functions returns `\n'.  And `\n' is not an
alternative for a literal newline.  For differences, please see
examples of newlines in the documentation of `print-escape-newlines'
in (info "(elisp)Output Variables").  It demonstrates that the
difference whether a function returns or prints a literal newline or
`\n' is preserved in the Emacs Lisp Reference Manual.

Since `thing-at-point' actually returns a literal newline instead of
`\n', it would be more correct to replace `\n' with a literal newline
in its example.

-- 
Juri Linkov
http://www.jurta.org/emacs/