From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: Docstrings and manuals Date: Sun, 17 Apr 2016 18:03:55 +0300 Message-ID: <831t64b7l0.fsf@gnu.org> 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> Reply-To: Eli Zaretskii NNTP-Posting-Host: plane.gmane.org X-Trace: ger.gmane.org 1460905476 10429 80.91.229.3 (17 Apr 2016 15:04:36 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sun, 17 Apr 2016 15:04:36 +0000 (UTC) Cc: rgm@gnu.org, michael.albinus@gmx.de, emacs-devel@gnu.org To: Dmitry Gutov Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Apr 17 17:04:35 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 1aroFW-0000G5-W5 for ged-emacs-devel@m.gmane.org; Sun, 17 Apr 2016 17:04:35 +0200 Original-Received: from localhost ([::1]:47451 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aroFW-0002Vx-54 for ged-emacs-devel@m.gmane.org; Sun, 17 Apr 2016 11:04:34 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:51133) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aroFH-0002ST-5g for emacs-devel@gnu.org; Sun, 17 Apr 2016 11:04:20 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1aroFC-0007RD-DY for emacs-devel@gnu.org; Sun, 17 Apr 2016 11:04:19 -0400 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:50171) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aroFC-0007R9-Ah; Sun, 17 Apr 2016 11:04:14 -0400 Original-Received: from 84.94.185.246.cable.012.net.il ([84.94.185.246]:4617 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_128_CBC_SHA1:128) (Exim 4.82) (envelope-from ) id 1aroF9-0006xi-5d; Sun, 17 Apr 2016 11:04:11 -0400 In-reply-to: <8dfdfe5d-41fe-7c05-0054-0bd3e589390e@yandex.ru> (message from Dmitry Gutov on Sun, 17 Apr 2016 13:50:35 +0300) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2001:4830:134:3::e 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:203012 Archived-At: > From: Dmitry Gutov > Date: Sun, 17 Apr 2016 13:50:35 +0300 > Cc: Glenn Morris , emacs-devel > > On 04/17/2016 11:49 AM, Michael Albinus wrote: > > > We will always find examples where the entries in the manual are > > inferior, compared with the docstring. We will also find examples with > > incompatible information in the docstring and the manual. > > 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. > > This does not mean that manuals are useless. It only means, that there's > > a bug to be fixed. > > 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. > Right now, I have no idea which one is supposed to be the primary source > of truth. Both. There's more than one way to tell the truth.