From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Joost Kremers Newsgroups: gmane.emacs.devel Subject: Re: docstrings and elisp reference Date: Tue, 06 Jun 2017 22:45:25 +0200 Message-ID: <878tl4976i.fsf@fastmail.fm> References: <0BB64F35-233A-471F-B99F-51F96C4E6CCB@gmail.com> <8360g99n07.fsf@gnu.org> <86lgp4q2xa.fsf@stephe-leake.org> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; format=flowed X-Trace: blaine.gmane.org 1496781982 7625 195.159.176.226 (6 Jun 2017 20:46:22 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Tue, 6 Jun 2017 20:46:22 +0000 (UTC) User-Agent: mu4e 0.9.19; emacs 25.2.50.1 Cc: emacs-devel To: Stephen Leake Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Tue Jun 06 22:46:17 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 1dILMl-0001S0-Vq for ged-emacs-devel@m.gmane.org; Tue, 06 Jun 2017 22:46:16 +0200 Original-Received: from localhost ([::1]:40053 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dILMo-0000xn-5d for ged-emacs-devel@m.gmane.org; Tue, 06 Jun 2017 16:46:18 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:55031) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dILMA-0000xh-NQ for emacs-devel@gnu.org; Tue, 06 Jun 2017 16:45:39 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dILM7-00067Z-Gn for emacs-devel@gnu.org; Tue, 06 Jun 2017 16:45:38 -0400 Original-Received: from out1-smtp.messagingengine.com ([66.111.4.25]:48071) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1dILM6-00065z-Ld for emacs-devel@gnu.org; Tue, 06 Jun 2017 16:45:35 -0400 Original-Received: from compute5.internal (compute5.nyi.internal [10.202.2.45]) by mailout.nyi.internal (Postfix) with ESMTP id 7A09B20D8C; Tue, 6 Jun 2017 16:45:32 -0400 (EDT) Original-Received: from frontend1 ([10.202.2.160]) by compute5.internal (MEProxy); Tue, 06 Jun 2017 16:45:32 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=fastmail.fm; h= cc:content-type:date:from:in-reply-to:message-id:mime-version :references:subject:to:x-me-sender:x-me-sender:x-sasl-enc :x-sasl-enc; s=fm1; bh=ZYVlSk0wlzgVuzxReFvYQJCK5TT9BtSGrncvZEHZW dI=; b=ZPC01yjGKLyxISzxVzM7IuAGwNFaC8htewwE7+FSNgFZ+mlgsLrBVm+Yt e7tiW+/DYNiZNe2zPSXuCXk526OuyfYzyUKWMvcV+AsjthkGE5E3wpI6Cxka3Oyn hsfpSTxLPqgYij7PZXAIaZZGoX8q62aDuoGF0CQq3WYt5VYbF4asypOaF5WrH096 VU762/odd+YMedf2h3ZlgJNP9wRrwxPHiHdFAlQaDwcWOgh9JSbNFjJqFcesPDkr uanAAASO4dffIgRzkau2fIdRJllL2ApSgEsi4TcqEbq/sa2UCTCtym2IsqE+b6pC +NgCDzJ+SKl+GpLEjg73BTFxAsOTA== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-type:date:from:in-reply-to :message-id:mime-version:references:subject:to:x-me-sender :x-me-sender:x-sasl-enc:x-sasl-enc; s=fm1; bh=ZYVlSk0wlzgVuzxReF vYQJCK5TT9BtSGrncvZEHZWdI=; b=CEEpwmSMMCUAwkTUoT6jz/+Oi9mHvy/Vm1 S3lZlXGKFbxu10IhtCGAzoI4v2WAbwKPl9rJ0JHY8/s3YEa0QpxHaPPxWNVMYedm UTRJPG9x0lP8nsHbEuWN+LXzXu1FKRoxKofOmcgX3i8Q7nzltKnlkj/npLhHIQme YWpa8Zk5tmSRk6dVYJKwYflLnk2uba0QRZnWtc44jCQ+1BhSM0zAA1sMvjwhSj0O mZ/uSpVLncEUF/jzSS10yknduIDE5ycgM+/eHj1IbpfdChg6r4i1rNZL4rXVa4Mo 2ezSbiai3kTkG0E/E/b9J/aowUPwBbN7y0SCTT4wunlesn1d7qMw== X-ME-Sender: X-Sasl-enc: 4aKvZO717PPedtQSf/iYLg4gn25cTNMnmkXCMtOYsTZa 1496781931 Original-Received: from IdeaPad.messagingengine.com (vpn26a.hotsplots.net [185.46.137.18]) by mail.messagingengine.com (Postfix) with ESMTPA id 4E2BF7E7AA; Tue, 6 Jun 2017 16:45:30 -0400 (EDT) In-reply-to: <86lgp4q2xa.fsf@stephe-leake.org> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 66.111.4.25 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:215480 Archived-At: On Tue, Jun 06 2017, Stephen Leake wrote: > Doc strings are for short reference information for single > functions/variables. > > texinfo docs are for more indepth explanations of several > related functions/features. > > They are complementary; they should not duplicate each other. And yet, the Elisp manual documents a large number of functions and variables / options in a format that is very reminiscent of doc strings and which provides basically the same information. I kinda see the point in making the doc string and that description identical. Obviously, the manual gives a lot more background info and groups the functions and variables together in a meaningful way, but wouldn't it make sense / be possible to extract the descriptions in the manual directly from the source? -- Joost Kremers Life has its moments