From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Emanuel Berg via "Emacs development discussions." Newsgroups: gmane.emacs.devel Subject: Re: Some ideas with Emacs Date: Sun, 01 Dec 2019 07:15:49 +0100 Message-ID: <86eexosh9m.fsf@zoho.eu> References: <837e3iq0ks.fsf@gnu.org> Reply-To: Emanuel Berg Mime-Version: 1.0 Content-Type: text/plain Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="66853"; mail-complaints-to="usenet@blaine.gmane.org" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1 (gnu/linux) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Dec 01 07:16:09 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 1ibIWe-000HAy-I0 for ged-emacs-devel@m.gmane.org; Sun, 01 Dec 2019 07:16:08 +0100 Original-Received: from localhost ([::1]:41026 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ibIWd-0000os-2h for ged-emacs-devel@m.gmane.org; Sun, 01 Dec 2019 01:16:07 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:36383) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ibIWW-0000om-JZ for emacs-devel@gnu.org; Sun, 01 Dec 2019 01:16:02 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ibIWV-0008FP-EB for emacs-devel@gnu.org; Sun, 01 Dec 2019 01:16:00 -0500 Original-Received: from 195-159-176-226.customer.powertech.no ([195.159.176.226]:34454 helo=blaine.gmane.org) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1ibIWV-0008EH-7P for emacs-devel@gnu.org; Sun, 01 Dec 2019 01:15:59 -0500 Original-Received: from list by blaine.gmane.org with local (Exim 4.89) (envelope-from ) id 1ibIWT-000Gzz-4I for emacs-devel@gnu.org; Sun, 01 Dec 2019 07:15:57 +0100 X-Injected-Via-Gmane: http://gmane.org/ Mail-Followup-To: emacs-devel@gnu.org Mail-Copies-To: never Cancel-Lock: sha1:haqxoIQV5cCiMGkXt+UC69pxm68= X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 195.159.176.226 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:242936 Archived-At: Richard Stallman wrote: >> It might be a good idea to encourage the >> addition of examples either in docstrings or >> in the Elisp manual (or both). > > The general intention is to make doc strings > somewhat terse, and speak at greater length > in the manual. So the place for these > examples is the manual, not the doc strings. But the docstrings are much more interactive and have a faster and more natural work-flow access! As long as the basic info is topmost and in the intuitive order according to the rules (with arguments etc) why can't one have a second (and third etc) paragraph with more elaborate info, and yes, examples? BTW as you know there are already examples in many docstrings, even Elisp - do like this, not like this. Great stuff IMO! -- underground experts united http://user.it.uu.se/~embe8573 https://dataswamp.org/~incal