From: Stefan Monnier <monnier@iro.umontreal.ca>
To: Jean-Christophe Helary <lists@traduction-libre.org>
Cc: Eli Zaretskii <eliz@gnu.org>, Lars Ingebrigtsen <larsi@gnus.org>,
stefan@marxist.se, asjo@koldfront.dk, emacs-devel@gnu.org
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 [thread overview]
Message-ID: <jwvr1fymm21.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <D92C32E8-C088-45E4-9B51-9B5825A30E63@traduction-libre.org> (Jean-Christophe Helary's message of "Fri, 16 Jul 2021 11:08:42 +0900")
Jean-Christophe Helary [2021-07-16 11:08:42] wrote:
>> On Jul 16, 2021, at 9:22, Stefan Monnier <monnier@iro.umontreal.ca> 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
next prev parent reply other threads:[~2021-07-16 13:22 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-14 15:05 Add hints to documentation of car and cdr for (e)lisp newcomers - take 2 Adam Sjøgren
2021-07-14 15:36 ` Andreas Schwab
2021-07-14 15:48 ` tomas
2021-07-14 15:50 ` Eli Zaretskii
2021-07-14 16:03 ` Lars Ingebrigtsen
2021-07-14 16:13 ` Eli Zaretskii
2021-07-15 4:34 ` Lars Ingebrigtsen
2021-07-14 23:49 ` Stefan Kangas
2021-07-15 4:38 ` Lars Ingebrigtsen
2021-07-15 11:39 ` Stefan Kangas
2021-07-15 14:14 ` Eli Zaretskii
2021-07-15 15:02 ` Tim Cross
2021-07-15 15:41 ` Stefan Monnier
2021-07-15 15:21 ` Stefan Monnier
2021-07-15 15:26 ` Yuan Fu
2021-07-15 15:52 ` Eduardo Ochs
2021-07-15 15:44 ` Lars Ingebrigtsen
2021-07-15 15:57 ` Eli Zaretskii
2021-07-16 0:22 ` Stefan Monnier
2021-07-16 2:08 ` Jean-Christophe Helary
2021-07-16 13:22 ` Stefan Monnier [this message]
2021-07-16 14:38 ` Basil L. Contovounesios
2021-07-16 7:00 ` Eli Zaretskii
2021-07-15 15:53 ` Eli Zaretskii
2021-07-15 16:17 ` Jean-Christophe Helary
2021-07-15 16:30 ` Lars Ingebrigtsen
2021-07-15 16:57 ` Eli Zaretskii
2021-07-15 17:01 ` Lars Ingebrigtsen
2021-07-15 17:07 ` Eli Zaretskii
2021-07-15 20:54 ` Stefan Kangas
2021-07-15 21:11 ` Lars Ingebrigtsen
2021-07-14 16:37 ` [External] : " Drew Adams
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=jwvr1fymm21.fsf-monnier+emacs@gnu.org \
--to=monnier@iro.umontreal.ca \
--cc=asjo@koldfront.dk \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=larsi@gnus.org \
--cc=lists@traduction-libre.org \
--cc=stefan@marxist.se \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).