unofficial mirror of help-gnu-emacs@gnu.org
 help / color / mirror / Atom feed
From: Jean Louis <bugs@gnu.support>
To: Michael Heerdegen <michael_heerdegen@web.de>
Cc: help-gnu-emacs@gnu.org
Subject: Re: Supplying DOC string in a `defun' using `defvar'
Date: Tue, 1 Jun 2021 04:07:18 +0300	[thread overview]
Message-ID: <YLWIRv8MUO/TgJ8R@protected.localdomain> (raw)
In-Reply-To: <87eedms9i6.fsf@web.de>

* Michael Heerdegen <michael_heerdegen@web.de> [2021-06-01 03:40]:
> 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?

Yes, obviously it is not practical, but it works. And is not me who
defines those functions. I am generating 50+ function aliases by
Drew's suggestion:

(defun hyperscope-generate-add-functions-by-hyperdocument-types ()
  (let ((types (hyperscope-hyperdocument-types)))
    (while types
      (let* ((type (pop types))
	     (id (nth 0 type))
	     (type (nth 1 type))
	     (type-name type)
	     (type (downcase (string-replace " " "-" type)))
	     (new-function-name (format "hyperscope-add-new-%s-hyperdocument" type)))
	(defalias (intern new-function-name)
	  (lambda ()
	    (interactive)
	    (let* ((parent (hyperscope-select-set))
		   (prompt (format "New `%s' hyperdocument name: " type-name))
		   (name (read-from-minibuffer prompt)))
	      (hlink-add-generic name "" id parent nil)))
	  (format "Add new `%s' hyperdocument to Hyperscope." type-name))))))

(hyperscope-generate-add-functions-by-hyperdocument-types)

This technique is handy as then user can simply add new type in the
database, visually, interactively, and new function is generated as a
hook that helps to add the new type. Even new key binding could be
generated automatically.

-- 
Jean

Take action in Free Software Foundation campaigns:
https://www.fsf.org/campaigns

Sign an open letter in support of Richard M. Stallman
https://stallmansupport.org/



  parent reply	other threads:[~2021-06-01  1:07 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
2021-06-01  1:07         ` Jean Louis [this message]
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

  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=YLWIRv8MUO/TgJ8R@protected.localdomain \
    --to=bugs@gnu.support \
    --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.
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).