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 11:21:42 -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> Mime-Version: 1.0 Content-Type: text/plain; charset=iso-8859-1 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="25881"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: Stefan Kangas , larsi@gnus.org, 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 Thu Jul 15 17:22:36 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 1m43C8-0006YN-9e for ged-emacs-devel@m.gmane-mx.org; Thu, 15 Jul 2021 17:22:36 +0200 Original-Received: from localhost ([::1]:35980 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m43C7-0002hS-5k for ged-emacs-devel@m.gmane-mx.org; Thu, 15 Jul 2021 11:22:35 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:36848) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m43BP-00021S-VW for emacs-devel@gnu.org; Thu, 15 Jul 2021 11:21:52 -0400 Original-Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:40550) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m43BL-00072g-R8; Thu, 15 Jul 2021 11:21:50 -0400 Original-Received: from pmg2.iro.umontreal.ca (localhost.localdomain [127.0.0.1]) by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id 0BCD3808DF; Thu, 15 Jul 2021 11:21:45 -0400 (EDT) Original-Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id CC02E80161; Thu, 15 Jul 2021 11:21:43 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1626362503; bh=S0hjP2MHifDIp0MvoYXWqsbmFze1wjraO2Tb9uggQjU=; h=From:To:Cc:Subject:References:Date:In-Reply-To:From; b=fv0GwevJDjqBNKE9CCs8XHvIG7qwsmI2fbZawPTVkew9jVZvY6gufp+zHHbl9Fr+s xyLCMuzPKSeJYtmGjIMqsAuyUPwKnoVR0gWCZBDy8GDiLfaJSBnLSLblK5pFen7m3v MZ5uiyi4BkhuXfz1slYTbJGpL8F0o2bj+3HMbyAOLc6eTNrPI2AJi9mOkd0e3lJPbh sXFQP0Ot3ad30DZZVIHX0q0dcYO5U7+nm6VfIRIzM/G8G5i/hmCOy0WV7kSr3UVDRv hpHJEJogUl8/xXk3hrhBRLU83tPC7B5lVJ2Y5eKjLXWWPdhQGIhzqA1l4oEjndV527 y9d55LV/m1MNA== Original-Received: from alfajor (unknown [216.154.29.138]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id 8B33C120281; Thu, 15 Jul 2021 11:21:43 -0400 (EDT) In-Reply-To: <831r7z7jgl.fsf@gnu.org> (Eli Zaretskii's message of "Thu, 15 Jul 2021 17:14:18 +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:271253 Archived-At: Eli Zaretskii [2021-07-15 17:14:18] wrote: >> From: Stefan Kangas >> Date: Thu, 15 Jul 2021 13:39:54 +0200 >> Cc: Eli Zaretskii , Adam Sj=F8gren ,=20 >> Emacs developers >> In general, I think we should include more examples in our >> documentation. shortdoc.el is a step forward here, and it would be >> even better if you could see those examples when you pull up the >> docstring of a function. > > IMO, examples are for the manual, not for the doc strings. If some > parts of our manuals could benefit from more examples, patches for > that would be welcome. I think displaying the examples we have in shortdoc.el in the *Help* buffer would make a lot of sense.