Re: [Emacs-diffs] master b533552 2/5: Documentation fixes re quotes

[Richard Stallman <rms@gnu.org>]

[[[ To any NSA and FBI agents reading my email: please consider    ]]]
[[[ whether defending the US Constitution against all enemies,     ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]

I think this change is misconceived.

  > diff --git a/doc/lispintro/emacs-lisp-intro.texi b/doc/lispintro/emacs-lisp-intro.texi
  > index f1480a4..a27a969 100644
  > --- a/doc/lispintro/emacs-lisp-intro.texi
  > +++ b/doc/lispintro/emacs-lisp-intro.texi
  > @@ -3862,10 +3862,10 @@ tiger!} will be printed; otherwise, @code{nil} will be returned.
  >  @group
  >  (defun type-of-animal (characteristic)
  >    "Print message in echo area depending on CHARACTERISTIC.
  > -If the CHARACTERISTIC is the symbol `fierce',
  > +If the CHARACTERISTIC is the symbol ?fierce?,
  >  then warn of a tiger."
  >    (if (equal characteristic 'fierce)
  > -      (message "It's a tiger!")))
  > +      (message "It?s a tiger!")))
  >  @end group
  >  @end smallexample

This is not an example of what appears in a Help buffer.
It is an example of source code.  Doc strings should be written
with straight quotes, so the example should show straight quotes.

Likewise, the call to message should use a straight quote.
It will usually typically _output_ a curly quote if it uses 'format-message',
but this example shows the source code, not the output.

This change is correct:

  >  When you evaluate @code{(type-of-animal 'fierce)}, you will see the
  > -following message printed in the echo area: @code{"It's a tiger!"}; and
  > +following message printed in the echo area: @code{"It?s a tiger!"}; and

It's correct because it shows the output.  However, the text should
explain (without the full detail) the difference in quotes.  Perhaps

   On terminals that can display curly quotes, 'message' changes ASCII
quotes to curly ones.

-- 
Dr Richard Stallman
President, Free Software Foundation (gnu.org, fsf.org)
Internet Hall-of-Famer (internethalloffame.org)
Skype: No way! See stallman.org/skype.html.