unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Stefan Monnier <monnier@iro.umontreal.ca>
To: Ted Zlatanov <tzz@lifelogs.com>
Cc: emacs-devel@gnu.org
Subject: Re: tags for functions
Date: Thu, 29 Jan 2009 16:52:04 -0500	[thread overview]
Message-ID: <jwv63jxkcsq.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <861vuldgmu.fsf@lifelogs.com> (Ted Zlatanov's message of "Thu, 29 Jan 2009 14:03:21 -0600")

SM> Stefan "who still doesn't know what data we're talking about"
>>> I'm interested in "@keyword" substrings of the docstring that indicate
>>> the keywords for a particular function.  The goals are to:
>>> - list all keywords
>>> - list all keywords for a function
>>> - list all functions for a keyword

SM> Not know what that data would be used for, it's hard to give you
SM> good feedback.
> The goal is to do the three operations above as an API.

This is not "what it's used for", it's "how it's provided".

> Then Emacs will use it, for example, to show related functions in C-h f
> The package can also provide browsing by keyword, as finder.el does.

I see, thanks.  The list of related functions can be rather long, so
it's probably better to only add a "show related" button in C-h f and
only show the list when the user asks for it.

> 1) modify defun-after-hook so new defun calls will be noted, or install
> advice on defun (I'd rather do the former)

I'd rather to try to avoid both.

> 2) scan existing docstrings over mapatoms using `documentation' (it's
> slow now apparently, so it will need to be optimized for a batch scan)

If it's only done "once per session" and only when the user specifically
asks for this info, it's probably not that bad.

> I only need defun-after-hook to be approved, I can do the rest.  Do you
> agree it's useful or would you rather not provide such a hook?

I'm not convinced.  I'm not even sure this kind of info will turn out to
be useful/usable.  Currently, you'd spend all your time scanning
docstrings that don't contain any such keywords.  Adding those keywords
to docstrings would be a major undertaking.  So it's probably better to
start with data from elsewhere (e.g. from the elisp manual) anyway.

In other words, maybe a defun-after-hook ill be the right tool, but
we're pretty far from being in a position to judge, and it seems likely
that the end design will use a completely different approach anyway.


        Stefan




  reply	other threads:[~2009-01-29 21:52 UTC|newest]

Thread overview: 36+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-01-20 20:36 tags for functions Ted Zlatanov
2009-01-20 20:44 ` Lennart Borgman
2009-01-21 22:11   ` Ted Zlatanov
2009-01-21 22:13     ` Lennart Borgman
2009-01-22 14:20       ` Ted Zlatanov
2009-01-22 19:39         ` Stefan Monnier
2009-01-22 20:09           ` Ted Zlatanov
2009-01-21 22:22     ` Glenn Morris
2009-01-22 14:54       ` Ted Zlatanov
2009-01-25  0:32         ` Juri Linkov
2009-01-26 19:50           ` Ted Zlatanov
2009-01-26 23:55             ` Juri Linkov
2009-01-27 14:31               ` Ted Zlatanov
2009-01-28  0:02                 ` Juri Linkov
2009-01-28  0:36                   ` Lennart Borgman
2009-01-28 17:41                   ` Ted Zlatanov
2009-01-28 18:40                     ` Stefan Monnier
2009-01-28 20:38                       ` Ted Zlatanov
2009-01-29  1:43                         ` Stefan Monnier
2009-01-29 20:03                           ` Ted Zlatanov
2009-01-29 21:52                             ` Stefan Monnier [this message]
2009-01-30 15:34                               ` Ted Zlatanov
2009-01-30 16:06                                 ` Drew Adams
2009-01-30 16:52                                   ` Ted Zlatanov
2009-01-31 17:52                                     ` Juri Linkov
2009-01-31  1:55                                   ` Stefan Monnier
2009-01-31  2:02                                     ` Drew Adams
2009-01-29 20:32                           ` Lennart Borgman
2009-01-30 15:29                             ` Ted Zlatanov
  -- strict thread matches above, loose matches on Subject: below --
2009-01-22  8:07 MON KEY
2009-01-22 14:47 ` Ted Zlatanov
2009-01-22 18:15 S+*n_Pe*rm*n
2009-01-22 18:49 ` MON KEY
2009-01-22 20:38 ` Ted Zlatanov
2009-01-23  1:46 S+*n_Pe*rm*n
2009-01-27 18:53 ` MON KEY

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=jwv63jxkcsq.fsf-monnier+emacs@gnu.org \
    --to=monnier@iro.umontreal.ca \
    --cc=emacs-devel@gnu.org \
    --cc=tzz@lifelogs.com \
    /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).