From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Yuan Fu 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:26:35 -0400 Message-ID: <34DECD1C-E6E0-4ED1-965D-2BCFD6ABB565@gmail.com> 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 (Mac OS X Mail 14.0 \(3654.60.0.2.21\)) Content-Type: multipart/alternative; boundary="Apple-Mail=_DEC82C47-98EF-4CD1-8FCC-031D9DFA77B9" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="11844"; mail-complaints-to="usenet@ciao.gmane.io" Cc: asjo@koldfront.dk, Eli Zaretskii , Stefan Kangas , Lars Ingebrigtsen , emacs-devel@gnu.org To: Stefan Monnier Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Thu Jul 15 17:27:48 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 1m43H9-0002rK-RG for ged-emacs-devel@m.gmane-mx.org; Thu, 15 Jul 2021 17:27:47 +0200 Original-Received: from localhost ([::1]:38228 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m43H6-0004Ny-Hk for ged-emacs-devel@m.gmane-mx.org; Thu, 15 Jul 2021 11:27:44 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:37608) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m43G3-0003iz-A4 for emacs-devel@gnu.org; Thu, 15 Jul 2021 11:26:39 -0400 Original-Received: from mail-qt1-x82a.google.com ([2607:f8b0:4864:20::82a]:40624) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1m43G1-0001tl-MH; Thu, 15 Jul 2021 11:26:39 -0400 Original-Received: by mail-qt1-x82a.google.com with SMTP id k3so4780149qtq.7; Thu, 15 Jul 2021 08:26:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:message-id:mime-version:subject:date:in-reply-to:cc:to :references; bh=hQgLNI31LiLJDbJHRPTzuQC8Iiz5537iskrEVdZkFD4=; b=RZOv1t2rFToC86dqAspFqNaJPtJ5AzHViuWUzsBTGKRf+uMpeiC4btW5BCqjmhxS1M OhaN/N4XqLB2LZx6/SjS8WzJlgxy6zxKStZpScoCPbroszezKrDS23+KUkSIgHBIFC+g 20aoqPqk6O7GgefxYiEHtO4xr7sKCXPLGimxYMm8C8gdXM/hsTIWg5FEBWd6FwpZ3+PF BLbVy1+Qkrj6GFutAeLBpOflekXk3Bs60OvoRL3ITjEB5qYxTITUR+v1DefBOCGMfKm2 gjOkTC8WRGWsx8mCx2G2JaFUxHTR+WuHvcRg0mPFWJzKpKrQi3Z27AUK6C8F+ZAKd25K sbaw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:message-id:mime-version:subject:date :in-reply-to:cc:to:references; bh=hQgLNI31LiLJDbJHRPTzuQC8Iiz5537iskrEVdZkFD4=; b=NIM6EG8j4XAzq+dU5TuR29064NjM0kTIf7p4RwwQZx4zARtANK1yJTIW2GMGu7DY16 MY2nCCZuXaL7p6yTcDczeNUgo3YTXI/BJGHYbKOMJ8fZPZa2Cx7qhWRGT7hAsy6nqie7 rdyjFstrQSCiptA2qDHZdjlNrH206hwgCeu7V/kTvkbvHDRgukG+PMb8oB0Hf9Tr+aEJ cAWf6gZAqY1OJn82+2q+UR16BYBMk1ZWu8lKeyszlZSm7mk8Htxw0EsyH9/cOiZuz+N4 16ViZg6ErZhSbx71ELeLEy2XL6xW/ftnUtbcsQ/yFerd6jiWbJqhKkNBAIvE83oldTNX 3pFw== X-Gm-Message-State: AOAM5300pF08pker2QU1KtsyKM7kaAd7tiv4T9oiPQH0Vj/h57/Lbw3S iHqpc8I6jWyYIVeLMFwmDeA= X-Google-Smtp-Source: ABdhPJxDP/yV3c4ZpYhfSVq2QdHrzWRXfYLW+eYZzvcl9L50aTEIKKjjiaQPuAtDbE0d8XzIfEF2aQ== X-Received: by 2002:ac8:1005:: with SMTP id z5mr4546100qti.255.1626362796418; Thu, 15 Jul 2021 08:26:36 -0700 (PDT) Original-Received: from ?IPv6:2601:98a:4200:9210:b02d:e0d8:dab6:21b? ([2601:98a:4200:9210:b02d:e0d8:dab6:21b]) by smtp.gmail.com with ESMTPSA id e123sm2640942qkf.103.2021.07.15.08.26.35 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Thu, 15 Jul 2021 08:26:36 -0700 (PDT) In-Reply-To: X-Mailer: Apple Mail (2.3654.60.0.2.21) Received-SPF: pass client-ip=2607:f8b0:4864:20::82a; envelope-from=casouri@gmail.com; helo=mail-qt1-x82a.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_NONE=-0.0001, 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:271254 Archived-At: --Apple-Mail=_DEC82C47-98EF-4CD1-8FCC-031D9DFA77B9 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=utf-8 > On Jul 15, 2021, at 11:21 AM, Stefan Monnier = wrote: >=20 > 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=C3=B8gren = ,=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. >>=20 >> 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. >=20 > I think displaying the examples we have in shortdoc.el in the > *Help* buffer would make a lot of sense. >=20 >=20 Some one wrote quite a few examples here: = https://github.com/xuchunyang/elisp-demos = Yuan= --Apple-Mail=_DEC82C47-98EF-4CD1-8FCC-031D9DFA77B9 Content-Transfer-Encoding: quoted-printable Content-Type: text/html; charset=utf-8

On Jul 15, 2021, at 11:21 AM, Stefan Monnier <monnier@iro.umontreal.ca> wrote:

Eli = Zaretskii [2021-07-15 17:14:18] wrote:
From: = Stefan Kangas <stefan@marxist.se>
Date: Thu, 15 Jul = 2021 13:39:54 +0200
Cc: Eli Zaretskii <eliz@gnu.org>, Adam = Sj=C3=B8gren <asjo@koldfront.dk>,
Emacs = developers <emacs-devel@gnu.org>
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.



Some one wrote quite a few examples here: https://github.com/xuchunyang/elisp-demos

Yuan
= --Apple-Mail=_DEC82C47-98EF-4CD1-8FCC-031D9DFA77B9--