From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: "Basil L. Contovounesios" 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 15:38:17 +0100 Message-ID: <874kcu1fza.fsf@tcd.ie> 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="8504"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: Jean-Christophe Helary , Eli Zaretskii , Lars Ingebrigtsen , stefan@marxist.se, asjo@koldfront.dk, emacs-devel@gnu.org To: Stefan Monnier Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Fri Jul 16 16:39:30 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 1m4Ozx-0001so-NP for ged-emacs-devel@m.gmane-mx.org; Fri, 16 Jul 2021 16:39:29 +0200 Original-Received: from localhost ([::1]:51990 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m4Ozw-0008Fs-7V for ged-emacs-devel@m.gmane-mx.org; Fri, 16 Jul 2021 10:39:28 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:52160) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m4Oyu-0007XV-OG for emacs-devel@gnu.org; Fri, 16 Jul 2021 10:38:24 -0400 Original-Received: from mail-wr1-x42f.google.com ([2a00:1450:4864:20::42f]:34730) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1m4Oys-0003lg-OR for emacs-devel@gnu.org; Fri, 16 Jul 2021 10:38:24 -0400 Original-Received: by mail-wr1-x42f.google.com with SMTP id u1so12415418wrs.1 for ; Fri, 16 Jul 2021 07:38:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=tcd.ie; s=google21; h=from:to:cc:subject:references:date:in-reply-to:message-id :user-agent:mime-version; bh=oCo9UBQg8ktBsD9koHA/XyWgF3pBhPxGKke8Kp6mynE=; b=gEgsvTRk3A0xlStmKlHfBiVDm4sftw5nfIggKsO/ajR0zA9dl21VtaIrAq5xFAcD4I HWtYimd//kPKcFtdgtjZoscq+0ifENjEPNYNRyesSOiKB7KQZk04UdkcUG6fElm6BJk6 xdRq/3WYI0QNXGoGRdmF79A6QtzaBPLQ6MGz0ith9dNpYyHPnksCjz7vK9NBAZW3E/N2 3xAG/DT9JRQRb/hTpOdtERjySKmTnvGSMJI01LX9/zb3xVSiZnhXmefDIkc4hubbRdUS uUZ6/gAoGWXiUjZeNLrq0B4IT2ayEYF5kYotTjJZEZwQZjDcsDU94j+MgmThM0xOdBgg CrJA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to :message-id:user-agent:mime-version; bh=oCo9UBQg8ktBsD9koHA/XyWgF3pBhPxGKke8Kp6mynE=; b=bsukyeyx1iDUH4R5XG8U+3/lgfk68YNsvXPvpNZ21+gl6ftge50wz1oWYqC39+2e8B kmmxx/NSGZkBgAbC1r4S0i0QTx1qCtrGrqKePJnYKTUukFQ1tlvt+Z+WDCH8mWzioDom rC/UtRh5lBFG1X4/5YPjU5AcDtCnyFkXMz1y6tWmlRbXXlEH70G1XkHhxwxBMQQS/U4V U/9z5I2ZhM8zq/8TKoPmLyqQfl3Upf/n9N+xKic6EkSx+CF6FTajxeYV3j7GZHZSAtzx BtCl3M+j+LLYKn+cs26NpGk3qqoSB8vuddZTjaciHJUUAiTA4GeHWziZ6+kREDaKUc8Q OKBg== X-Gm-Message-State: AOAM5301LaF4Rnt040wUG+5xxC/N9ndGgXbQLMmEjAdaM8HDnrAg/V8X XFDZv8Ud3oeP1AIFs1CBnmvnTQ== X-Google-Smtp-Source: ABdhPJxHOoLpDZe6hAWRmb0m1ZEzP7BJnq5Yk9JD3O7Th3zmukHSX0uL3NDaDOh8v91Fc7ZDeg9Dhw== X-Received: by 2002:a5d:4089:: with SMTP id o9mr12818069wrp.274.1626446299401; Fri, 16 Jul 2021 07:38:19 -0700 (PDT) Original-Received: from localhost ([2a02:8084:20e2:c380:f410:82e8:3a21:eedf]) by smtp.gmail.com with ESMTPSA id h15sm9938346wrq.88.2021.07.16.07.38.18 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 16 Jul 2021 07:38:18 -0700 (PDT) In-Reply-To: (Stefan Monnier's message of "Fri, 16 Jul 2021 09:22:23 -0400") Received-SPF: pass client-ip=2a00:1450:4864:20::42f; envelope-from=contovob@tcd.ie; helo=mail-wr1-x42f.google.com X-Spam_score_int: -1 X-Spam_score: -0.2 X-Spam_bar: / X-Spam_report: (-0.2 / 5.0 requ) DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, 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:271306 Archived-At: Stefan Monnier writes: >> What is the way to add examples to the shordoc display ? > > I think currently you need to add them to shortdoc.el. FWIW, packages can also use the macro define-short-documentation-group or function shortdoc-add-function outside of shortdoc.el. Their only current limitation is that they require shortdoc.el to be loaded, so external packages that wish to avoid that and the required backward-compatibility dance will inevitably resort to using (with-eval-after-load 'shortdoc ...). I'm fine with that, though. -- Basil