emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Add hints to documentation of car and cdr for (e)lisp newcomers - ta


From: Stefan Monnier
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
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux)

> 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




reply via email to

[Prev in Thread] Current Thread [Next in Thread]