From: Stefan Monnier <monnier@iro.umontreal.ca>
To: emacs-devel@gnu.org
Subject: Re: Better help support for EIEIO classes and methods
Date: Mon, 04 Feb 2013 14:53:53 -0500 [thread overview]
Message-ID: <jwvr4kvj1za.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <87txprhq5g.fsf@engster.org> (David Engster's message of "Mon, 04 Feb 2013 19:47:55 +0100")
>> To a large extent the first line is not that important since you can add
>> the missing info in the docstring itself. Could you give more details of
>> the things that can't be overcome this way?
> An example: Start up with emacs -Q and eval
> (require 'semantic/db)
> (require 'semantic/db-global)
> Then do a describe-function on semanticdb-file-table. You'll get this:
> ,----
> | semanticdb-file-table is a Lisp function in `db.el'.
> |
> | (semanticdb-file-table &rest LOCAL-ARGS)
> |
> | From OBJ, return FILENAME's associated table object.
> `----
> Now, this is pretty misleading since there are actually two
> implementations of this function, which will become clear if you use
> eieio-describe-generic, which will give you this:
Here's a suggestion: in describe-function-1 we do:
(help-fns--compiler-macro function)
(help-fns--parent-mode function)
(help-fns--obsolete function)
How 'bout we replace that with
(run-hook-with-args 'help-fns-describe-function-functions function)
So EIEIO can add some text between "(semanticdb-file-table &rest
LOCAL-ARGS)" and "From OBJ, return FILENAME's associated table object."?
> This is already pretty good, but is still lacking an IMO crucial
> feature: the filenames 'db.el' and 'db-global.el' are not
> links. However, just do
> (add-hook 'temp-buffer-show-hook 'eieio-help-mode-augmentation-maybee t)
Can't you insert the `db.el' and `db-globals.el' directly as buttons?
Or does something later strip away the text-properties of those buttons?
If that's the case, maybe we could fix that problem.
Stefan
next prev parent reply other threads:[~2013-02-04 19:53 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-02-03 15:42 Better help support for EIEIO classes and methods David Engster
2013-02-04 3:28 ` Stefan Monnier
2013-02-04 18:47 ` David Engster
2013-02-04 19:53 ` Stefan Monnier [this message]
2013-02-05 21:23 ` David Engster
2013-02-06 14:45 ` Stefan Monnier
2013-02-06 16:19 ` David Engster
2013-02-06 19:16 ` Stefan Monnier
2013-02-10 15:21 ` David Engster
2013-02-11 3:57 ` Stefan Monnier
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=jwvr4kvj1za.fsf-monnier+emacs@gnu.org \
--to=monnier@iro.umontreal.ca \
--cc=emacs-devel@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.