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: Thu, 15 Jul 2021 20:22:30 -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="3955"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: Lars Ingebrigtsen , stefan@marxist.se, asjo@koldfront.dk, emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Fri Jul 16 02:23:18 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 1m4BdO-0000pH-Ne for ged-emacs-devel@m.gmane-mx.org; Fri, 16 Jul 2021 02:23:18 +0200 Original-Received: from localhost ([::1]:38874 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m4BdM-0002yb-RD for ged-emacs-devel@m.gmane-mx.org; Thu, 15 Jul 2021 20:23:16 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:34676) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m4Bcl-0002Ju-E5 for emacs-devel@gnu.org; Thu, 15 Jul 2021 20:22:39 -0400 Original-Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:55053) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m4Bci-0002xq-4D; Thu, 15 Jul 2021 20:22:38 -0400 Original-Received: from pmg3.iro.umontreal.ca (localhost [127.0.0.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id C66B4441265; Thu, 15 Jul 2021 20:22:32 -0400 (EDT) Original-Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id CA91D440FB4; Thu, 15 Jul 2021 20:22:31 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1626394951; bh=1yeVW85KIoyf8bI2+P4o5ggF0xh1jViA/WxfnGlODW8=; h=From:To:Cc:Subject:References:Date:In-Reply-To:From; b=M0o59dn9cY1J00S9cMycwEtKBN2mokKXFhMZ17SF0Xf/pUDr3/O+HR1mVmlj5+9KE 3FM5K1uhQL2f9KqiVvQ9Wu1/28mFtcD+zpQjDY2ueWDT5O7H/h5yh8udi9MWbUlLbX ubjT2mUGJjg8nhXco6227nkknNZU0BGMgI9AQ0yZpVNhiozhcQf8cVYek7PJ83/Fhk GV1eOSaR2CjimHuQSj94Kbv0RkWbGDsUdB0LrRaYQ8114OUK2ANk37H+qcTogF6JsU bcOwfD46xnlqXeQ1nKB2tNENiUt81w+6qjCcs+ewaxLeSYeFB+g4gssrkbOyVARqf1 qf515ZLuGvMew== Original-Received: from alfajor (unknown [216.154.29.138]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id 89740120298; Thu, 15 Jul 2021 20:22:31 -0400 (EDT) In-Reply-To: <83sg0f603p.fsf@gnu.org> (Eli Zaretskii's message of "Thu, 15 Jul 2021 18:57:46 +0300") 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:271280 Archived-At: > 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. 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). Stefan