From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Michael Albinus Newsgroups: gmane.emacs.devel Subject: Re: Some ideas with Emacs Date: Fri, 29 Nov 2019 21:09:18 +0100 Message-ID: <878snyxx5d.fsf@gmx.de> References: <837e3iq0ks.fsf@gnu.org> <87h82my0fm.fsf@gmx.de> <83tv6mo4vl.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain Content-Transfer-Encoding: quoted-printable Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="94490"; mail-complaints-to="usenet@blaine.gmane.org" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux) Cc: emacs-devel@gnu.org, stefan@marxist.se, monnier@iro.umontreal.ca, c4droid@foxmail.com To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Fri Nov 29 21:13:07 2019 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1iamdS-000OHh-J2 for ged-emacs-devel@m.gmane.org; Fri, 29 Nov 2019 21:13:02 +0100 Original-Received: from localhost ([::1]:34960 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iamdO-0005vK-KV for ged-emacs-devel@m.gmane.org; Fri, 29 Nov 2019 15:12:59 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:43094) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iamaB-0005Nu-SY for emacs-devel@gnu.org; Fri, 29 Nov 2019 15:09:41 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iamaA-0002xB-S3 for emacs-devel@gnu.org; Fri, 29 Nov 2019 15:09:39 -0500 Original-Received: from mout.gmx.net ([212.227.15.18]:55643) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iamaA-0002ku-Hc; Fri, 29 Nov 2019 15:09:38 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1575058160; bh=E/ntMoCAiJtqGoBLUysDGrfTn9JifvQ165gW/+uPkB0=; h=X-UI-Sender-Class:From:To:Cc:Subject:References:Date:In-Reply-To; b=Ur0YgMETkiWCnxNZ09O7hKOuUtRsV/m2cYfdnv729FEESg1Kw2vRPCtBNGjx9Nxar 5jpyWvsq73JWE8V/sTeDQtYmAPDc3AW/iyGNOX2m2J4K1Ysg3DwTt4Vig2lCpWn0Wq FJipY+T0mr0SsafAcMXub6SPi18ltdQcPzUowV9k= X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c Original-Received: from detlef.gmx.de ([212.91.243.137]) by mail.gmx.com (mrgmx005 [212.227.17.190]) with ESMTPSA (Nemesis) id 1MfHAH-1i8ZMh2HxT-00gqSM; Fri, 29 Nov 2019 21:09:20 +0100 In-Reply-To: <83tv6mo4vl.fsf@gnu.org> (Eli Zaretskii's message of "Fri, 29 Nov 2019 21:32:30 +0200") X-Provags-ID: V03:K1:GQzrvbRHT9Hra9/DHV0YXncIapwkF9MYRGA3BMv07Ofa3Z9+UYd YYMlRUvKRIierclfNuvUGsNDyArCL77tqFZHsP7hwXRe24pNuhcK3NZsnOvEFRi85h5Zd+8 YvLXfTOVLOn2J8Ipt5af7HA/OF3CcaNdlcXNmJhczDh+AGMviEd2Sid4Ccy7T0GkkTX51Rr YXYSk8RCSmFA/2UfkMIqw== X-UI-Out-Filterresults: notjunk:1;V03:K0:ry/5nadr7JE=:LgBY05SAN0XjtjciG3mgdv d9P2H2TThRDR2tOVlcDk3qUkR/hX5OpCzBiqPSP+LegTA4gtG07Kgc3k915qqCl4dUn7f74Qh jVpmi67N/m0kejwsGu7akUIz0Q+nE2rIoRv2LU2/mIX4xBz4/M6BuB8pOC40YEe+AxF0Hcxkg GpN45xVdFMtv2L2vKbZOZ2Zo/W/ek48QsG4li2SKJ03DBzooFVTqoK4w8u7oH/6QxM+N4Ifum 7dw4gjfwjX8dpGHQg7G7p40KYfoeMjEtsZKs/m2gRXlz3JGnNxSMzIrX1UL1OkG64pohHCS2M +t9Ll2zHv25ul0OZZOEYdsiat9cjtygajKWzrcA0OxtyA1mjTIl4Zl9vHQ2p/DQwdk95uumcy ZQoU81cmPzu9eZNUYuVnK7QSQfUqWd1xWYoQzEEqpnC0F6HMC2787ryUeDgn+oyfCdqCJxklw bD03sHkijUwddNrzQs1YAQugURBr5jt1Sm2+y149In0ctFX5fHgRCp1UW2bS8Gxu/zvYpmUhT vm5ptUYhPDKfSxVA1AvLhu8YEN2VjmJjXxCDU2kNdhLfw7yHR/KXRBzr4dzmPdCAbJVziU367 x4/yLNAt2k19WnfDr2pNrLPoj+gy5cDNkqIDtK1+9p8bhn30Oykj75Nnm3DH7bGk6Ii2v7Hqy q/L/mrS0JfL/JI+PpiwsDRZKD5mcWSD0h2jNhG8Gs77tYVdZ3d3pO7W36X8PR7ezES1Jc0H57 56nl1TFTFivgYi3HxiuGbsqRFEw8Vf4O8CYLi3MuNfEOX90EvIWNFDPDU91Gydi3LbwwqOsr X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 212.227.15.18 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 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:242890 Archived-At: Eli Zaretskii writes: >> > AFACT, currently we have some examples in the Elisp manual and very >> > few examples in docstrings. >> > It might be a good idea to encourage the addition of examples either = in >> > docstrings or in the Elisp manual (or both). >> >> Personally, I don't like docstring to be too verbose. Usually, when a >> function is documented with both docstrings and a manual, I prefer to >> put the examples in the manual. > > I agree: the examples should be mostly in the manual. Doc strings > should only have examples if it is otherwise very hard to explain > something. Shall we say something like this in "(elisp) Documentation Tips"? Best regards, Michael.