From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Dmitry Gutov Newsgroups: gmane.emacs.devel Subject: Re: Docstrings and manuals Date: Sun, 17 Apr 2016 18:15:17 +0300 Message-ID: <3c95a1a7-a334-73e7-0644-71aa0d862b50@yandex.ru> References: <6ok2vyzwf9.fsf@fencepost.gnu.org> <08f70cda-44be-0657-e50a-2b2c80d2c21c@yandex.ru> <87oa9dzgl0.fsf@gmx.de> <87potshczh.fsf@gmx.de> <87h9f4ghzg.fsf@gmx.de> <8737qnc8ep.fsf@gmx.de> <87k2jwd3gr.fsf_-_@gmx.de> <8dfdfe5d-41fe-7c05-0054-0bd3e589390e@yandex.ru> <831t64b7l0.fsf@gnu.org> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=windows-1252; format=flowed Content-Transfer-Encoding: 8bit X-Trace: ger.gmane.org 1460906158 20270 80.91.229.3 (17 Apr 2016 15:15:58 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sun, 17 Apr 2016 15:15:58 +0000 (UTC) Cc: rgm@gnu.org, michael.albinus@gmx.de, emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Apr 17 17:15:53 2016 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 1aroQS-0005Y9-LU for ged-emacs-devel@m.gmane.org; Sun, 17 Apr 2016 17:15:52 +0200 Original-Received: from localhost ([::1]:47616 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aroQR-0004E6-Td for ged-emacs-devel@m.gmane.org; Sun, 17 Apr 2016 11:15:51 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:53625) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aroQ4-0003zi-4X for emacs-devel@gnu.org; Sun, 17 Apr 2016 11:15:28 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1aroQ0-0001aH-4H for emacs-devel@gnu.org; Sun, 17 Apr 2016 11:15:28 -0400 Original-Received: from mail-wm0-x229.google.com ([2a00:1450:400c:c09::229]:37270) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aroPz-0001a2-Si; Sun, 17 Apr 2016 11:15:24 -0400 Original-Received: by mail-wm0-x229.google.com with SMTP id n3so92121681wmn.0; Sun, 17 Apr 2016 08:15:23 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=sender:subject:to:references:cc:from:message-id:date:user-agent :mime-version:in-reply-to:content-transfer-encoding; bh=CVhAlKXJB+bl581pG5cFQSrXAuU+p1vsB+Goa8QGK1k=; b=cxEA2r+UFjE8si609ehI+qPkkfpvQPplTFJLMRBh34q9JOwF5ytNZFdncwhg4sVufM dJJ7Xf19hmw8Eq4WW2QGhX7YeqJBhyosT1lsT9WI80XBgcEztd5+MySekLURCFMbu1KZ kgWoxQMGoCZsMe9RrQ7dYwMnFcDYmpQQflr3CAx4A/pErG0UZ6wPKT2zftq2v/fQqnYR KN7Dqdr1yHkeQblqNabK5/yA0yeYkE9dsuEx9FD4X6gRRjzrWHW2LDBMOJMu+cILtlII cXVGZ3oNMD2uajcs+DrI5wzoSDXxYLxS/davd2FzMmLDso3DnzquB1QPXUCEsg4aoKIp FAXA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:sender:subject:to:references:cc:from:message-id :date:user-agent:mime-version:in-reply-to:content-transfer-encoding; bh=CVhAlKXJB+bl581pG5cFQSrXAuU+p1vsB+Goa8QGK1k=; b=TE85QPIA3mh40P7mRm7u+b2jtUKw0ohJarsCdEyEsl+sBY8cRodY9RXcMPNewXyWlQ kbVFtVeMnZ2diLBU2OojucjoaXiWmUUVO2T+MSaTEdg+xc783+FdFsgyAfyvXweEFO72 fYx782I/Yy13f4IoVfw2SoO+IFERg8X7RQ3S9Iwo1NgkwPOD2HBcfPnSCvyUF9elYu+D 409ZlrMK7HHEWEC0lpbDy4dUL3nfkOIMSGccCVqNbBVI+xrp3zTXvB1Gks6PFHqhe5Fw b1g37k8xRmK7M7GEzunRUkF+WYdxZd9caVND2TLHRJy226e+wQsyu2EV3jKrll2P9Phk YWUQ== X-Gm-Message-State: AOPr4FUtU+U2uF+SQ14YmixScjk6nLVmR8y/s/nB2AsCmSOmiNKYsPe4/8lZe1IJ4Ucm8Q== X-Received: by 10.194.14.130 with SMTP id p2mr33824994wjc.173.1460906123223; Sun, 17 Apr 2016 08:15:23 -0700 (PDT) Original-Received: from [192.168.1.2] ([185.105.175.24]) by smtp.googlemail.com with ESMTPSA id gr4sm23798648wjd.23.2016.04.17.08.15.20 (version=TLSv1/SSLv3 cipher=OTHER); Sun, 17 Apr 2016 08:15:22 -0700 (PDT) User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:45.0) Gecko/20100101 Thunderbird/45.0 In-Reply-To: <831t64b7l0.fsf@gnu.org> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2a00:1450:400c:c09::229 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.21 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" Xref: news.gmane.org gmane.emacs.devel:203015 Archived-At: On 04/17/2016 06:03 PM, Eli Zaretskii wrote: >> The `mapatoms' manual entry is neither. And yet, wouldn't you agree that >> it's problematic? > > If you mean that mapatoms' doc string is too terse and omits some > details it shouldn't, I agree. Otherwise, I'm not sure what you mean; > please elaborate. That someone saw fit to put "Then it returns ‘nil’" into the manual when it's not in the docstring. And that it's easy to make such a mistake. >> Sure. But I think that means that we should have a policy that the >> manual is secondary to the information contained in the source files. > > No, it's not secondary. It should be an expanded and augmented > version of the same information. Either you're saying the same as me (when writing a manual, you elaborate, but not add new essential new information, and thus make a derivative), or I don't understand how to produce the manual entries. > Both. There's more than one way to tell the truth. Both of them are necessarily fallible, it seems.