From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Dmitry Gutov Newsgroups: gmane.emacs.devel Subject: Re: docstrings and elisp reference Date: Wed, 7 Jun 2017 00:50:23 +0300 Message-ID: <0d081c78-3e64-4cc3-afdd-471b49f21f24@yandex.ru> References: <0BB64F35-233A-471F-B99F-51F96C4E6CCB@gmail.com> <8360g99n07.fsf@gnu.org> <86lgp4q2xa.fsf@stephe-leake.org> <13fd66c8-b22b-5b87-bd8c-34dbe0c7ec38@yandex.ru> <3d5a1ca0-645f-421f-8044-f344c586705d@default> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit X-Trace: blaine.gmane.org 1496785839 13632 195.159.176.226 (6 Jun 2017 21:50:39 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Tue, 6 Jun 2017 21:50:39 +0000 (UTC) User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:54.0) Gecko/20100101 Thunderbird/54.0 To: Drew Adams , Stephen Leake , emacs-devel Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Tue Jun 06 23:50:32 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 1dIMMy-00039u-6Z for ged-emacs-devel@m.gmane.org; Tue, 06 Jun 2017 23:50:32 +0200 Original-Received: from localhost ([::1]:40220 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dIMN3-0001ZI-DU for ged-emacs-devel@m.gmane.org; Tue, 06 Jun 2017 17:50:37 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:45045) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dIMMx-0001ZA-Jl for emacs-devel@gnu.org; Tue, 06 Jun 2017 17:50:32 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dIMMu-0002T7-Hx for emacs-devel@gnu.org; Tue, 06 Jun 2017 17:50:31 -0400 Original-Received: from mail-wr0-x232.google.com ([2a00:1450:400c:c0c::232]:36673) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1dIMMu-0002Sh-BC for emacs-devel@gnu.org; Tue, 06 Jun 2017 17:50:28 -0400 Original-Received: by mail-wr0-x232.google.com with SMTP id v111so53274834wrc.3 for ; Tue, 06 Jun 2017 14:50:28 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:subject:to:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-language:content-transfer-encoding; bh=NxWm8us22YDIjtcRI3vzWDE+ngmTLlC5c4IswIBD/Zc=; b=JDeDfcm9K98oILWFXJ/oZFGeCY2ka7oJsOd1x7T/3CdF/Ncx5nxayjKP1XWniPkab0 PPbaVjnALSIxLHkF68rGB1rC3vN0MuCsqVMQa7pI7fJmHYQmKHT/MLKW13C0070gnn1W N+kVhaJEMX0cRYj1t5vw6NTWJ4CzQDS+lRsNz97AQgfdZfKrNTj6n81BfBjJTbnxp1qh 6yKxwwyB918Fxp5YYT6kK92Jw5XIFufjVVxqwh/qmErG5MjlumDkuZqd8avCBrkJGrGH ImyLK5vfHeUA6hRFXpqn6g7OhjV3qp3Rg/uTLRbSemNDQaYvs2NXYwvnYW18aVkNnImD 0NJA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:subject:to:references:from:message-id :date:user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=NxWm8us22YDIjtcRI3vzWDE+ngmTLlC5c4IswIBD/Zc=; b=ilY6F5H7Fw8Ti9NGz+TczrQhPAUOo5vLDTkV/wfAu8slRqyCanhnnPcANO9LervCJN nTIp7JoT3hxdtnA39aVzEJ3+mrmh3vSjBb4DC/JWfKJgNJQsL6XAEWu/jyofumPYZRM0 MyxNk87WGXmaJvdaWhyVjuxLXMF4dlRS4e/yEy2kUcVrXwjRMoHFmffZOyP9jyAbgKYT 9Z5iE55xZnp28k7YJGmLSKE2VzXTLIsjoYgMBRqnE1YEEUXtwvkdUj2InE49cNSG3095 VUMxzeOE2SapVDuE/n/kef4lAn/33NjkIXgxTK8zDxce8BXCg90LsJ1hWs4dlbPshSrj DNXg== X-Gm-Message-State: AODbwcAAUlxIJw71lPemoy9S/IU0Z7gizq5/wM9hHNgj2/Qrnzv9Vxmo 3FgYrs8ALwkJTZU9MvI= X-Received: by 10.223.133.240 with SMTP id 45mr18589413wru.51.1496785826858; Tue, 06 Jun 2017 14:50:26 -0700 (PDT) Original-Received: from [192.168.1.3] ([185.105.174.193]) by smtp.googlemail.com with ESMTPSA id m19sm184732wmc.3.2017.06.06.14.50.25 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 06 Jun 2017 14:50:25 -0700 (PDT) In-Reply-To: <3d5a1ca0-645f-421f-8044-f344c586705d@default> Content-Language: en-US X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:400c:c0c::232 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:215484 Archived-At: On 6/7/17 12:21 AM, Drew Adams wrote: >>> they should not duplicate each other. >> >> Then you have something else in mind than the current >> situation with documentation in Emacs. > > No, you do, if you think the intention now is that > they duplicate each other. It never has been. Please look up the difference between "intention" and "current situation". > Some of the information is often the same; that's all. That's called "duplication". > In particular, doc strings are written as user help. > The interactive use, if any, is typically described > first, and from the point of an interactive user. > Not so, the Elisp manual. We have different manuals, with different goals. The fact that docstrings often describe the interactive case (when it exists) doesn't make them necessarily targeted at the end user. Just exhaustive.