From: ludvig-faddeev@gmx.com
To: Michael Heerdegen <michael_heerdegen@web.de>
Cc: help-gnu-emacs@gnu.org
Subject: Supplying DOC string in a `defun' using `defvar'
Date: Tue, 1 Jun 2021 03:00:53 +0200 [thread overview]
Message-ID: <trinity-b53f822f-6abb-483d-945b-650d8c4d767d-1622509253592@3c-app-mailcom-bs01> (raw)
In-Reply-To: <87eedms9i6.fsf@web.de>
> Sent: Tuesday, June 01, 2021 at 12:40 PM
> From: "Michael Heerdegen" <michael_heerdegen@web.de>
> To: help-gnu-emacs@gnu.org
> Subject: Re: Supplying DOC string in a `defun' using `defvar'
>
> Jean Louis <bugs@gnu.support> writes:
>
> > (defvar my-doc "Hello there")
> >
> > (defmacro my-fun ()
> > `(defun my-fun ()
> > ,my-doc
> > (ignore)))
>
> Would you want the body to be stored in another defvar? Then your code
> would be even smaller.
>
> I'm only partially joking, actually, not at all - is the function's
> documentation for your code's readers really that much less important
> than its code? Maybe it's even the other way round?
I would still want to provide it, but want to keep user centered and developer
centered parts to be distinct. Have worked with the literate programming environment
introduced by Knuth in the early 1980s but have not bought the result.
next prev parent reply other threads:[~2021-06-01 1:00 UTC|newest]
Thread overview: 83+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-31 23:00 Supplying DOC string in a `defun' using `defvar' ludvig-faddeev
2021-05-31 23:11 ` 2QdxY4RzWzUUiLuE
2021-05-31 23:13 ` Jean Louis
2021-05-31 23:32 ` ludvig-faddeev
2021-05-31 23:43 ` Jean Louis
2021-06-01 0:14 ` 2QdxY4RzWzUUiLuE
2021-06-01 0:23 ` Jean Louis
2021-06-01 0:35 ` Jean Louis
2021-06-01 0:40 ` Michael Heerdegen
2021-06-01 1:00 ` ludvig-faddeev [this message]
2021-06-01 1:07 ` Jean Louis
2021-06-01 1:28 ` Michael Heerdegen
2021-06-01 1:33 ` Jean Louis
2021-06-01 13:39 ` Michael Heerdegen
2021-06-01 16:31 ` Jean Louis
2021-06-01 22:44 ` Michael Heerdegen
2021-06-01 3:26 ` Stefan Monnier via Users list for the GNU Emacs text editor
2021-06-01 5:19 ` Christopher Dimech
2021-06-01 14:31 ` Michael Heerdegen
2021-06-01 14:41 ` Christopher Dimech
2021-06-01 15:01 ` [External] : " Drew Adams
2021-06-01 15:05 ` Christopher Dimech
2021-06-01 15:38 ` Stefan Monnier via Users list for the GNU Emacs text editor
2021-06-01 18:20 ` Christopher Dimech
2021-06-01 18:25 ` Eli Zaretskii
2021-06-01 18:33 ` Christopher Dimech
2021-06-02 2:53 ` Stefan Monnier via Users list for the GNU Emacs text editor
2021-06-02 22:46 ` Michael Heerdegen
2021-06-02 22:56 ` Christopher Dimech
2021-06-03 6:52 ` Jean Louis
2021-06-03 7:23 ` Eduardo Ochs
2021-06-03 9:19 ` Jean Louis
2021-06-03 14:17 ` Eduardo Ochs
2021-06-02 15:59 ` FW: " Drew Adams
2021-06-02 16:19 ` Christopher Dimech
2021-06-02 17:24 ` Drew Adams
2021-06-02 18:14 ` Christopher Dimech
2021-06-01 22:39 ` Michael Heerdegen
2021-06-01 22:43 ` Christopher Dimech
2021-06-02 2:55 ` Stefan Monnier via Users list for the GNU Emacs text editor
2021-06-02 4:55 ` Christopher Dimech
2021-06-02 5:06 ` Jean Louis
2021-06-02 13:09 ` Stefan Monnier
2021-06-02 13:35 ` Christopher Dimech
2021-06-02 14:43 ` Christopher Dimech
2021-06-02 15:08 ` Stefan Monnier
2021-06-02 16:14 ` Christopher Dimech
2021-06-02 15:53 ` Drew Adams
2021-06-02 18:35 ` Stefan Monnier
2021-06-02 18:59 ` Jean Louis
2021-06-02 19:55 ` Drew Adams
2021-06-02 19:58 ` Drew Adams
2021-06-02 21:26 ` Stefan Monnier
2021-06-02 22:24 ` Drew Adams
2021-06-02 22:39 ` Stefan Monnier
2021-06-02 22:52 ` Christopher Dimech
2021-06-02 23:11 ` Stefan Monnier
2021-06-03 10:57 ` Christopher Dimech
2021-06-03 13:43 ` Christopher Dimech
2021-06-03 15:10 ` Stefan Monnier
2021-06-03 15:34 ` Christopher Dimech
2021-06-03 15:46 ` Stefan Monnier
2021-06-03 16:18 ` Christopher Dimech
2021-06-03 6:29 ` Jean Louis
2021-06-03 6:22 ` Eli Zaretskii
2021-06-03 6:59 ` Lars Ingebrigtsen
2021-06-01 15:46 ` Drew Adams
2021-06-01 16:34 ` Jean Louis
2021-06-01 18:51 ` Nick Dokos
2021-06-01 19:02 ` Christopher Dimech
2021-06-01 22:15 ` Robert Thorpe
2021-06-01 23:08 ` Christopher Dimech
2021-05-31 23:20 ` [External] : " Drew Adams
2021-05-31 23:31 ` Michael Heerdegen
2021-05-31 23:46 ` ludvig-faddeev
2021-06-01 0:29 ` Michael Heerdegen
2021-06-01 0:35 ` ludvig-faddeev
2021-06-01 1:08 ` Michael Heerdegen
2021-06-01 1:49 ` ludvig-faddeev
2021-06-01 14:26 ` Michael Heerdegen
2021-06-01 21:50 ` ludvig-faddeev
2021-06-01 22:22 ` Michael Heerdegen
2021-05-31 23:40 ` Jean Louis
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=trinity-b53f822f-6abb-483d-945b-650d8c4d767d-1622509253592@3c-app-mailcom-bs01 \
--to=ludvig-faddeev@gmx.com \
--cc=help-gnu-emacs@gnu.org \
--cc=michael_heerdegen@web.de \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.