From: <tomas@tuxteam.de>
To: help-gnu-emacs@gnu.org
Subject: Re: Defun Self Documentation
Date: Thu, 5 Nov 2020 16:45:38 +0100 [thread overview]
Message-ID: <20201105154537.GA24492@tuxteam.de> (raw)
In-Reply-To: <trinity-cdeeefbf-2c25-428d-b69c-1b45ee925968-1604589369830@3c-app-mailcom-bs14>
[-- Attachment #1: Type: text/plain, Size: 487 bytes --]
On Thu, Nov 05, 2020 at 04:16:09PM +0100, Christopher Dimech wrote:
>
> When using defun, can one include a Self Documenting string or is
> Self-Documentation only applicable for interactive functions?
>
> (defun Gdn ()
> "Description"
> Body ...
> )
No need to be interactive.
Minor nit: convention in Lisp is
(defun Gdn ()
"Description"
Body ... )
i.e. closing parens don't get a line of their own. Readers will
thank you :)
Cheers
- t
[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 198 bytes --]
next prev parent reply other threads:[~2020-11-05 15:45 UTC|newest]
Thread overview: 60+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-05 15:16 Defun Self Documentation Christopher Dimech
2020-11-05 15:45 ` tomas [this message]
2020-11-05 15:55 ` Christopher Dimech
2020-11-05 16:00 ` tomas
2020-11-05 16:10 ` Christopher Dimech
2020-11-05 18:08 ` Jean Louis
2020-11-05 19:34 ` Christopher Dimech
2020-11-05 16:15 ` Drew Adams
2020-11-05 16:27 ` Christopher Dimech
2020-11-05 16:41 ` Stefan Monnier
2020-11-05 16:51 ` Arthur Miller
2020-11-05 16:59 ` Christopher Dimech
2020-11-05 17:28 ` Stefan Monnier
2020-11-05 17:29 ` Michael Heerdegen
2020-11-05 17:50 ` Christopher Dimech
2020-11-05 19:35 ` Michael Heerdegen
2020-11-05 19:22 ` Joost Kremers
2020-11-05 19:38 ` Emanuel Berg via Users list for the GNU Emacs text editor
2020-11-05 19:50 ` Eli Zaretskii
2020-11-05 21:02 ` Emanuel Berg via Users list for the GNU Emacs text editor
2020-11-06 5:27 ` Eli Zaretskii
2020-11-06 7:07 ` Emanuel Berg via Users list for the GNU Emacs text editor
2020-11-06 7:18 ` Emanuel Berg via Users list for the GNU Emacs text editor
2020-11-06 7:45 ` Eli Zaretskii
2020-11-06 8:17 ` tomas
2020-11-06 8:38 ` Emanuel Berg via Users list for the GNU Emacs text editor
2020-11-06 8:45 ` tomas
2020-11-09 3:22 ` Emanuel Berg via Users list for the GNU Emacs text editor
2020-11-06 8:44 ` Gregory Heytings via Users list for the GNU Emacs text editor
2020-11-06 11:54 ` Eli Zaretskii
2020-11-06 12:12 ` Christopher Dimech
2020-11-06 17:36 ` Gregory Heytings via Users list for the GNU Emacs text editor
2020-11-06 18:03 ` Christopher Dimech
2020-11-09 3:49 ` Emanuel Berg via Users list for the GNU Emacs text editor
2020-11-06 18:39 ` Eli Zaretskii
2020-11-09 4:00 ` Emanuel Berg via Users list for the GNU Emacs text editor
2020-11-09 3:48 ` Emanuel Berg via Users list for the GNU Emacs text editor
2020-11-09 3:45 ` Emanuel Berg via Users list for the GNU Emacs text editor
2020-11-09 3:29 ` Emanuel Berg via Users list for the GNU Emacs text editor
2020-11-06 11:10 ` Defun Self Documentation (let us do it different) Jean Louis
2020-11-09 4:01 ` Emanuel Berg via Users list for the GNU Emacs text editor
2020-11-06 17:02 ` Defun Self Documentation Stefan Monnier
2020-11-06 18:35 ` Eli Zaretskii
2020-11-06 18:50 ` Stefan Monnier
2020-11-06 19:07 ` Christopher Dimech
2020-11-06 19:23 ` Stefan Monnier
2020-11-06 19:41 ` Christopher Dimech
2020-11-05 16:07 ` Drew Adams
2020-11-05 18:41 ` Emanuel Berg via Users list for the GNU Emacs text editor
-- strict thread matches above, loose matches on Subject: below --
2020-11-06 9:10 Anders Munch
2020-11-06 11:58 ` Eli Zaretskii
2020-11-06 15:33 Anders Munch
2020-11-06 15:48 ` Eli Zaretskii
2020-11-06 16:07 ` Christopher Dimech
2020-11-09 4:08 ` Emanuel Berg via Users list for the GNU Emacs text editor
2020-11-09 4:26 ` Emanuel Berg via Users list for the GNU Emacs text editor
2020-11-09 4:39 ` Emanuel Berg via Users list for the GNU Emacs text editor
2020-11-09 13:32 ` Eric S Fraga
2020-11-11 15:34 ` Michael Heerdegen
2020-11-09 15:51 ` Eli Zaretskii
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=20201105154537.GA24492@tuxteam.de \
--to=tomas@tuxteam.de \
--cc=help-gnu-emacs@gnu.org \
/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.