From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Richard Stallman Newsgroups: gmane.emacs.devel Subject: Re: [Emacs-diffs] master b533552 2/5: Documentation fixes re quotes Date: Mon, 31 Aug 2015 20:03:57 -0400 Message-ID: References: <20150831061236.27796.57762@vcs.savannah.gnu.org> <55E3F3AD.2010602@yandex.ru> <55E3F6B6.20205@cs.ucla.edu> <55E3F88A.50003@yandex.ru> <55E3F9D7.6040601@cs.ucla.edu> Reply-To: rms@gnu.org NNTP-Posting-Host: plane.gmane.org Content-Type: text/plain; charset=Utf-8 X-Trace: ger.gmane.org 1441065886 1207 80.91.229.3 (1 Sep 2015 00:04:46 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Tue, 1 Sep 2015 00:04:46 +0000 (UTC) Cc: emacs-devel@gnu.org, dgutov@yandex.ru To: Paul Eggert Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Tue Sep 01 02:04:37 2015 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1ZWZ40-0003tN-CW for ged-emacs-devel@m.gmane.org; Tue, 01 Sep 2015 02:04:36 +0200 Original-Received: from localhost ([::1]:42538 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZWZ40-0001cm-5r for ged-emacs-devel@m.gmane.org; Mon, 31 Aug 2015 20:04:36 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:40149) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZWZ3V-0001C6-OC for emacs-devel@gnu.org; Mon, 31 Aug 2015 20:04:09 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZWZ3U-0000P5-VF for emacs-devel@gnu.org; Mon, 31 Aug 2015 20:04:05 -0400 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:34955) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZWZ3O-0000Le-Kh; Mon, 31 Aug 2015 20:03:58 -0400 Original-Received: from rms by fencepost.gnu.org with local (Exim 4.82) (envelope-from ) id 1ZWZ3N-0000gR-Me; Mon, 31 Aug 2015 20:03:57 -0400 In-reply-to: <55E3F9D7.6040601@cs.ucla.edu> (message from Paul Eggert on Sun, 30 Aug 2015 23:53:11 -0700) X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-Received-From: 2001:4830:134:3::e X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:189362 Archived-At: [[[ 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.