GNU bug report logs - #18346
Missing feature; smart contextual documentation (help buffers)

Previous Next

To reply to this bug, email your comments to 18346 AT debbugs.gnu.org.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: user3341592 <user47795 <at> hush.mail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: Missing feature; smart contextual documentation (help buffers)
Date: Thu, 28 Aug 2014 19:50:18 +0200

Here is a missing feature which Stefan asked to report.

See http://stackoverflow.com/questions/25551120/bind-f1-to-smart-contextual-documentation-help-buffers.

--8<---------------cut here---------------start------------->8---
Is there a function which I could bind on F1 in Emacs, which would give
me (in a temporary or persistent buffer) contextual documentation on the
"symbol" under point?

IIUC, that'd give the same results as:

- C-c C-v RET in ESS buffers (= ess-display-help-on-object)
- C-h f/v RET in Emacs Lisp buffers (= describe-function/variable)
- C-h S in Shell buffers (= info-lookup-symbol) + M-x man-follow?
- ??? in AWK, C, Java
- ??? in AUCTeX buffers (well, that may be a big dream ;-))
- ...

Somehow, Auto-Complete does that job (at least in ESS and Emacs Lisp
buffers), as it displays the right help (on functions, on variables,
etc.) in its "quick help" tooltip. Though, it's only displayed in the
completion process, not after.

I first thought that info-lookup-symbol would be (part of) the solution,
but it already does NOT work in ESS, so it's pretty very limited...

What should I bind onto F1, then?
--8<---------------cut here---------------end--------------->8---

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.