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 9ce1d38: Use curved quotes in core elisp diagnostics Date: Mon, 24 Aug 2015 16:20:13 -0400 Message-ID: References: <20150816160149.9416.80132@vcs.savannah.gnu.org> <55D1043C.3030909@yandex.ru> <20150816225346.GA5367@acm.fritz.box> <55D2C080.2000806@cs.ucla.edu> <55D40B81.3030805@cs.ucla.edu> Reply-To: rms@gnu.org NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Trace: ger.gmane.org 1440447665 30186 80.91.229.3 (24 Aug 2015 20:21:05 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 24 Aug 2015 20:21:05 +0000 (UTC) Cc: emacs-devel@gnu.org To: Paul Eggert Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Aug 24 22:20:54 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 1ZTyEg-0004UR-Do for ged-emacs-devel@m.gmane.org; Mon, 24 Aug 2015 22:20:54 +0200 Original-Received: from localhost ([::1]:56584 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZTyEf-00005Y-IV for ged-emacs-devel@m.gmane.org; Mon, 24 Aug 2015 16:20:53 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:33620) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZTyE5-0008Rx-7z for emacs-devel@gnu.org; Mon, 24 Aug 2015 16:20:19 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZTyE3-0001C2-Nu for emacs-devel@gnu.org; Mon, 24 Aug 2015 16:20:17 -0400 Original-Received: from fencepost.gnu.org ([208.118.235.10]:57523) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZTyE1-000185-SS; Mon, 24 Aug 2015 16:20:13 -0400 Original-Received: from rms by fencepost.gnu.org with local (Exim 4.82) (envelope-from ) id 1ZTyE1-0003WE-B5; Mon, 24 Aug 2015 16:20:13 -0400 In-reply-to: <55D40B81.3030805@cs.ucla.edu> (message from Paul Eggert on Tue, 18 Aug 2015 21:52:17 -0700) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.10 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:189129 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. ]]] > helpful to have these work in doc strings too. As a simple example, the Elisp > manual says this: > -- Function: eql value1 value2 > This function acts like ‘eq’ except when both arguments are > numbers. It compares numbers by type and numeric value,... > If I were to write a similar function I might copy some of this into the new > function's doc string and then adapt it, like this: > (defun eqfuzz (value1 value2) > "Compare two values but use fuzzy comparison on numbers. > This function acts like ‘eq’ except when both arguments are numbers.... Doc strings and Lisp manual entries are written in a very different style; to start with a Lisp manual entry and edit it into a doc string, you will have to do a lot of rewriting. If you must also change the quotes, that's a tiny bit of extra work. What you should really do is go to the source of the original function and copy its doc string. That's already in the style you want, so you won't have to make changes (other than for your change in the functionality), and as a small bonus you also won't have to change the way quoting is written. For doc strings in the source, we should stick to ASCII quotes. -- 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.