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:14:45 +0300 Message-ID: <83y48c9sii.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> <8737qkcwoo.fsf@gmx.de> <909c91ef-aa2e-4bcc-9828-603c4203e3d0@yandex.ru> <87y48cctr6.fsf@gmx.de> <149a61a2-d812-5ae1-d969-d4201872e870@yandex.ru> Reply-To: Eli Zaretskii NNTP-Posting-Host: plane.gmane.org X-Trace: ger.gmane.org 1460906127 19967 80.91.229.3 (17 Apr 2016 15:15:27 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sun, 17 Apr 2016 15:15:27 +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:15:21 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 1aroPw-0005JG-Oi for ged-emacs-devel@m.gmane.org; Sun, 17 Apr 2016 17:15:20 +0200 Original-Received: from localhost ([::1]:47609 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aroPw-0002xb-6n for ged-emacs-devel@m.gmane.org; Sun, 17 Apr 2016 11:15:20 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:53317) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aroPh-0002sC-Uv for emacs-devel@gnu.org; Sun, 17 Apr 2016 11:15:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1aroPd-0001PE-VN for emacs-devel@gnu.org; Sun, 17 Apr 2016 11:15:05 -0400 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:50356) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aroPd-0001P2-St; Sun, 17 Apr 2016 11:15:01 -0400 Original-Received: from 84.94.185.246.cable.012.net.il ([84.94.185.246]:4621 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_128_CBC_SHA1:128) (Exim 4.82) (envelope-from ) id 1aroPc-00048N-Q9; Sun, 17 Apr 2016 11:15:01 -0400 In-reply-to: <149a61a2-d812-5ae1-d969-d4201872e870@yandex.ru> (message from Dmitry Gutov on Sun, 17 Apr 2016 16:12:05 +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:203014 Archived-At: > From: Dmitry Gutov > Date: Sun, 17 Apr 2016 16:12:05 +0300 > Cc: Glenn Morris , emacs-devel > > My problem is that you stated the lack of a manual as the reason for > your lack of understanding of VC's internals. I'm saying the problem is > them being documented insufficiently in the code. And, like I mentioned, > if you go ahead and write the newfound revelations in the manual, but > not anywhere else, a certain slice of developers is going to miss out. yes, we should update both the doc strings and the manual(s). > To put a different spin on my statement earlier: if neither the > docstrings, nor the manual are considered the Single Source of Truth, to > read a reasonably complete description of a function, I'd have to read > both the docstring and the manual. And that's just wasteful. > > And even the personal preferences aside, we can't make the manual to be > the SSOT because most functions are not documented there. The doc strings and the manual should convey the same information, where they both cover the same turf.