From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Monnier Newsgroups: gmane.emacs.devel Subject: Re: Add hints to documentation of car and cdr for (e)lisp newcomers - take 2 Date: Fri, 16 Jul 2021 09:22:23 -0400 Message-ID: References: <8735shrl57.fsf@tullinup.koldfront.dk> <83v95c7v3v.fsf@gnu.org> <87bl74evd7.fsf@gnus.org> <87bl74ry2z.fsf@gnus.org> <831r7z7jgl.fsf@gnu.org> <87r1fzinu1.fsf@gnus.org> <83sg0f603p.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="27852"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: Eli Zaretskii , Lars Ingebrigtsen , stefan@marxist.se, asjo@koldfront.dk, emacs-devel@gnu.org To: Jean-Christophe Helary Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Fri Jul 16 15:38:43 2021 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1m4O38-00074z-VD for ged-emacs-devel@m.gmane-mx.org; Fri, 16 Jul 2021 15:38:42 +0200 Original-Received: from localhost ([::1]:41048 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m4O37-0001nO-V1 for ged-emacs-devel@m.gmane-mx.org; Fri, 16 Jul 2021 09:38:41 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:37962) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m4O0k-00043y-Nv for emacs-devel@gnu.org; Fri, 16 Jul 2021 09:36:15 -0400 Original-Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:61091) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m4NnS-00036h-90; Fri, 16 Jul 2021 09:22:32 -0400 Original-Received: from pmg2.iro.umontreal.ca (localhost.localdomain [127.0.0.1]) by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id F065D8068C; Fri, 16 Jul 2021 09:22:26 -0400 (EDT) Original-Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id 53265808D1; Fri, 16 Jul 2021 09:22:25 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1626441745; bh=Wwk3pb6oZ63F57SIZU7JC5ieGG47DxTRKPX1FJHkylA=; h=From:To:Cc:Subject:References:Date:In-Reply-To:From; b=oRlFTMMtTBPL42WAICZ14yEGUlr7Q4by0L5/Df/CvORCqOC0wl+1dgay/tvdyq2NC 8kddDrk1BtOLIVQEOZCeM7G2uHr73cpmKRGvddtSxUdQPgp+n68NnuSizol9t6DAix JCx72iu1i2UCaGM5oJy7R5FQ26m8Km3VTo+e1/3QJqZNaqBXlpTp/efh09POnMFbuA muiNCsTSf2XvY9r73uO8iiS+qdh2JXvIFbUTx7dC5g27aOlEhRUQAMepa3AOOsvPXG UpEkccW2ObGf3rZUa9EDh89TvjuXt0iXZjJNOaBdSGLtULwq0WODaKbn4xL9I5xjvi X+fvJ0P9ZhEgA== Original-Received: from alfajor (unknown [216.154.29.138]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id ED72D1202DA; Fri, 16 Jul 2021 09:22:24 -0400 (EDT) In-Reply-To: (Jean-Christophe Helary's message of "Fri, 16 Jul 2021 11:08:42 +0900") Received-SPF: pass client-ip=132.204.25.50; envelope-from=monnier@iro.umontreal.ca; helo=mailscanner.iro.umontreal.ca X-Spam_score_int: -42 X-Spam_score: -4.3 X-Spam_bar: ---- X-Spam_report: (-4.3 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_MED=-2.3, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action 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-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:271302 Archived-At: Jean-Christophe Helary [2021-07-16 11:08:42] wrote: >> On Jul 16, 2021, at 9:22, Stefan Monnier wrote: >>> The danger of going overboard is exactly what bothers me. Which is >>> why I think examples in doc strings should be used in exceptional >>> cases, where they are absolutely necessary. Not as a "why not?" >>> addition. >> I don't think docstring should come with examples. Examples should be >> provided separately for use by shortdoc.el and friends. > Do you have a list of "friends"? I don't have many friends, I'm afraid, no ;-) > What is the way to add examples to the shordoc display ? I think currently you need to add them to shortdoc.el. >> Then `C-h f` can also show those examples, but it can place them >> elsewhere (e.g. hidden by default with a button to show them or >> something like that). > So, that mechanism does not exist yet, correct ? Correct. Stefan