From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Tino Calancha Newsgroups: gmane.emacs.devel Subject: Re: docstrings and elisp reference Date: Tue, 6 Jun 2017 09:09:27 +0900 (JST) Message-ID: References: NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII; format=flowed X-Trace: blaine.gmane.org 1496707817 31059 195.159.176.226 (6 Jun 2017 00:10:17 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Tue, 6 Jun 2017 00:10:17 +0000 (UTC) User-Agent: Alpine 2.20 (DEB 67 2015-01-07) Cc: emacs-devel To: Jean-Christophe Helary Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Tue Jun 06 02:10:13 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 1dI24Z-0007mX-CJ for ged-emacs-devel@m.gmane.org; Tue, 06 Jun 2017 02:10:11 +0200 Original-Received: from localhost ([::1]:35633 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dI24e-0007GA-FH for ged-emacs-devel@m.gmane.org; Mon, 05 Jun 2017 20:10:16 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:56178) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dI241-0007Ft-5d for emacs-devel@gnu.org; Mon, 05 Jun 2017 20:09:37 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dI23x-0000a0-2O for emacs-devel@gnu.org; Mon, 05 Jun 2017 20:09:37 -0400 Original-Received: from mail-pf0-x231.google.com ([2607:f8b0:400e:c00::231]:36672) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1dI23w-0000Yh-TB for emacs-devel@gnu.org; Mon, 05 Jun 2017 20:09:32 -0400 Original-Received: by mail-pf0-x231.google.com with SMTP id m17so90088454pfg.3 for ; Mon, 05 Jun 2017 17:09:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:date:to:cc:subject:in-reply-to:message-id:references :user-agent:mime-version; bh=sWpKz06rMiW/rwzmnSUOOjrgOgc0ZvVBJsKJ6XUxsZ0=; b=XYELRfNWYTuHhuIQEUqTFLieg8MO2d2QX2jBsNx4EY+kYJ+IP0bylTMpbVPqCEdFKc Vge/CKd5h0A6dr4s84ueZlpZEhv9WI0tnPkbTTFjol/JzYuR7r1vvb5McMHZGOjSicNU lMPlAIluVMyf5x4yyw9OYo0l531liZ2DWrkjKn2025fu4JXy8ouPaB9kHK3/WrEhM502 hK5VM1e/N7z8I6rxX97X90e1spHpFI1XYhCoVPLUVJ2hOPvqGj49mTG0qfORV6NofedH 7SKMoHcj0iN/QIwpuMbYo7q1uFvaQjN7LCwd+hKFBl8ZpjeZrtMhCFgRqvxHPidjYC3R zCsg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:date:to:cc:subject:in-reply-to:message-id :references:user-agent:mime-version; bh=sWpKz06rMiW/rwzmnSUOOjrgOgc0ZvVBJsKJ6XUxsZ0=; b=RFMtwb4f3gs78gT3FC3M+JhpP1X5ABR8USAzqQlM8ls4jk3mV66cdcBXeb92bDAWtv NJFI29yvP+yy2kADGjwEvIzoJY9zxowdiA2iLAdgZ0c9GIb3ruECh2GpgGck0QmjK3lY CoQDuKLKoa3camq5pAwtFMbf2tYuoxSwLEojSPtrVg0wEZf9on0zmq20fcqo2W4A68Im O4LSpphGLOTIdz1v6rBKc9qO759k9opFx3q1ZtH9y8rkzmzL0gP2CsWGcvuGAX8xuxJv CMcVG9NKJYT50xc9M8OYWhgF6qm3Sx05W1+mZkdb82sD3Y4ymY7F53JVutG1r4ydimN5 Tibg== X-Gm-Message-State: AODbwcBvvxuyj851rICs4D/7gwgMSS+ToXALwUT+sz6OU3PU6wtRq9cj U73MwSLli4W3zw== X-Received: by 10.84.205.70 with SMTP id o6mr4057184plh.32.1496707770624; Mon, 05 Jun 2017 17:09:30 -0700 (PDT) Original-Received: from calancha-pc (222.139.137.133.dy.bbexcite.jp. [133.137.139.222]) by smtp.gmail.com with ESMTPSA id y2sm59654583pfa.65.2017.06.05.17.09.28 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 05 Jun 2017 17:09:29 -0700 (PDT) X-Google-Original-From: Tino Calancha X-X-Sender: calancha@calancha-pc In-Reply-To: X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2607:f8b0:400e:c00::231 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:215463 Archived-At: On Tue, 6 Jun 2017, Jean-Christophe Helary wrote: > I was thinking (naively?) that having the docstrings on one side and the reference on the other side was not a very efficient way to maintain documentation. Is everything in the documentation actually written by hand based on the docstrings? Wouldn't it be nicer to have good docstrings and use them directly in the documentation to avoid duplication of work? Is there any reason I'm not seeing why this is not happening? Hi, you might wish to read the following thread: https://lists.gnu.org/archive/html/emacs-devel/2016-04/msg00452.html