From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Jean-Christophe Helary Newsgroups: gmane.emacs.devel Subject: docstrings and elisp reference Date: Tue, 6 Jun 2017 06:26:07 +0900 Message-ID: NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 (Mac OS X Mail 10.3 \(3273\)) Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: blaine.gmane.org 1496698006 25160 195.159.176.226 (5 Jun 2017 21:26:46 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Mon, 5 Jun 2017 21:26:46 +0000 (UTC) To: emacs-devel Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Jun 05 23:26:43 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 1dHzWM-0006GE-TT for ged-emacs-devel@m.gmane.org; Mon, 05 Jun 2017 23:26:43 +0200 Original-Received: from localhost ([::1]:35236 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dHzWS-0003IE-AD for ged-emacs-devel@m.gmane.org; Mon, 05 Jun 2017 17:26:48 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:44868) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dHzVt-0003Hx-EE for emacs-devel@gnu.org; Mon, 05 Jun 2017 17:26:14 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dHzVp-0007ai-Ci for emacs-devel@gnu.org; Mon, 05 Jun 2017 17:26:13 -0400 Original-Received: from mail-pf0-x22d.google.com ([2607:f8b0:400e:c00::22d]:34951) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1dHzVp-0007aM-6d for emacs-devel@gnu.org; Mon, 05 Jun 2017 17:26:09 -0400 Original-Received: by mail-pf0-x22d.google.com with SMTP id l89so14279745pfi.2 for ; Mon, 05 Jun 2017 14:26:09 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:content-transfer-encoding:mime-version:subject:message-id:date :to; bh=f2yE0WIqbp9+aACrHXnnv9lAdGFWFeroxyT4zQ7csYU=; b=IkoROHFVIY7EOZ9I4IkokZ8K4AP7BcEi/kd2sR81rKYG/Lq+Zt/lsdb9XHR2AROpc6 9BNvAW1/ntft8SxeTkxnce0h2MPYn7OGgkHlnluZWbm4cPlxvBNjLa1quaE3zWlSwBir k5872t3DFzxaotlgdps8GLmXxop5zBlwELSifp3Lw43keNnC46JUxCfyEQ5Fn8mDiIqC XCSil6gx/JEbNwVmW5p8Dyv+Ey3DrhJXMmAgMgEZrykzbJWN10adTKBs0w5T2co1myo9 vgsX4hZV71Ib1Dzx23CEOzYhgGbgKBfwm0EVH+4IntIucM8N80YXhEYb+q7974eulJBc zPlw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:content-transfer-encoding:mime-version :subject:message-id:date:to; bh=f2yE0WIqbp9+aACrHXnnv9lAdGFWFeroxyT4zQ7csYU=; b=f41be4Cqfq2mM16XlChaDsKIKTa1PGWbbVPAJGxw4ju4Fq+RQUsp61egWWrhTgUBcH rA6YCuZAaEXuWikJbqgsrV/ipHQcBx0Hpirb5NUzgWJ6zZ837KhvN0W0mHP+xNB4oD99 KqMGpsc8NDGirAzli0LCd+6XvJRsVNCbiI0RzmlWIF/7DviCz3NOJdNv/RY3VgNK79ww UcUzQpY84VT9+it2m+N8JP2CbCgNpUNYP3BpXWIkOksRRgqG7XnEnomNi9KOWAYY8rSh xUnyqsjJHEBO6s4BojgBY2ZUOlWKFdDdgSRvcG+ZqA/YEKGKOiZriRN5rjtgUUWnTJjL U0bA== X-Gm-Message-State: AODbwcBNLu4lRF0JsGRN4YS7mvGHvOW0/L7GWHcIrnOW2XyZ1/p7pNPx 1k1R/AKAdtqDaM9k9wU= X-Received: by 10.98.94.134 with SMTP id s128mr17420639pfb.43.1496697968175; Mon, 05 Jun 2017 14:26:08 -0700 (PDT) Original-Received: from [192.168.24.55] (pl2587.ag0304.nttpc.ne.jp. [128.53.196.27]) by smtp.gmail.com with ESMTPSA id w67sm38152402pgb.7.2017.06.05.14.26.07 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 05 Jun 2017 14:26:07 -0700 (PDT) X-Mailer: Apple Mail (2.3273) X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2607:f8b0:400e:c00::22d 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:215460 Archived-At: 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? Jean-Christophe=20=