From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: docstrings and elisp reference Date: Wed, 07 Jun 2017 18:43:23 +0300 Message-ID: <83k24n952c.fsf@gnu.org> References: <0BB64F35-233A-471F-B99F-51F96C4E6CCB@gmail.com> <8360g99n07.fsf@gnu.org> <86lgp4q2xa.fsf@stephe-leake.org> <878tl4976i.fsf@fastmail.fm> Reply-To: Eli Zaretskii NNTP-Posting-Host: blaine.gmane.org X-Trace: blaine.gmane.org 1496850265 24218 195.159.176.226 (7 Jun 2017 15:44:25 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Wed, 7 Jun 2017 15:44:25 +0000 (UTC) Cc: emacs-devel@gnu.org To: Stefan Monnier Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Wed Jun 07 17:44:22 2017 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dId89-0005om-NJ for ged-emacs-devel@m.gmane.org; Wed, 07 Jun 2017 17:44:21 +0200 Original-Received: from localhost ([::1]:44686 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dId8A-0000vD-1U for ged-emacs-devel@m.gmane.org; Wed, 07 Jun 2017 11:44:22 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:44469) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dId7N-0000tq-K3 for emacs-devel@gnu.org; Wed, 07 Jun 2017 11:43:34 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dId7I-0000Fj-OE for emacs-devel@gnu.org; Wed, 07 Jun 2017 11:43:33 -0400 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:52146) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dId7I-0000Fc-LY; Wed, 07 Jun 2017 11:43:28 -0400 Original-Received: from 84.94.185.246.cable.012.net.il ([84.94.185.246]:4119 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1dId7H-0006Fy-V8; Wed, 07 Jun 2017 11:43:28 -0400 In-reply-to: (message from Stefan Monnier on Wed, 07 Jun 2017 09:03:04 -0400) 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:215503 Archived-At: > From: Stefan Monnier > Date: Wed, 07 Jun 2017 09:03:04 -0400 > > >From where I stand, the way to fix it is: > - Better integration between the manual browser and the docstring > browser, so you can click on a function/variable name in the manual to > get to its docstring and you can easily jump from a docstring to the > relevant section of the manual. > - Remove the redundant var/fun documentation from the manual (this is > a tedious job: there is some redundance but it's not systematic, so > we can't just do this removal systematically). > - Come up with a way to re-add those var/fun documentation into the > printed manual (e.g. by adding to the Texinfo source external > references to docstrings, which are then processed by now ad-hoc > script). FWIW, I disagree with this direction. I think we will end up with a much lower-level of documentation if we go that way. I also very much doubt we will find a volunteer to perform the 2nd item of that list: it's a very large and ungrateful job, and some of the text to be removed is IMNSHO excellent prose which it would be pity to lose.