unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#60568: [FR] 30.0.50; Help buffers and function bodies for generated functions
@ 2023-01-05  7:56 Ihor Radchenko
  2023-01-05  8:09 ` Eli Zaretskii
                   ` (4 more replies)
  0 siblings, 5 replies; 41+ messages in thread
From: Ihor Radchenko @ 2023-01-05  7:56 UTC (permalink / raw)
  To: 60568

Hi,

There have been a discussion [1] about including some of the helpful
package [2] features into built-in *Help* buffers.

One of the discussed features was displaying function source code right
in *Help* buffers. This feature usefulness have been objected at that
time, on the grounds that showing function code may be too long and
cause large *Help* buffers.

Recently, we have stumbled upon a situation when showing function code
is not only useful, but one of the few sane ways to examine it [3].
Functions that are not directly written in the source but rather
generated programmatically cannot currently be easily examined using
built-in help functionality (using describe-function or other means).
The help buffer only links to the (point-min) in the library defining
the generated function - not very helpful. In contrast, helpful extracts
function body from symbol function slot.

To illustrate, one can try the following:

1. emacs -Q
2. M-: (require 'ob-shell)
3. <F1> f org-babel-execute:sh <RET>
4. Click on the source code link in *Help* buffer
5. Observe point jumping to (point-min) with no obvious way to find the
   function definition.

Would it be possible to provide function body info via *Help* system in
Emacs?

[1]
https://yhetil.org/emacs-devel/AM9PR09MB4977A7738F83C5C24EF5829196D59@AM9PR09MB4977.eurprd09.prod.outlook.com

[2] https://github.com/Wilfred/helpful

[3] https://orgmode.org/list/87h6x8kluc.fsf@localhost

In GNU Emacs 30.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version
 3.24.35, cairo version 1.17.6) of 2023-01-02 built on localhost
Repository revision: 9377a3c889aa3b178a11a3b849c3d1665da096d6
Repository branch: master
Windowing system distributor 'The X.Org Foundation', version 11.0.12101004
System Description: Gentoo Linux


-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>





^ permalink raw reply	[flat|nested] 41+ messages in thread

end of thread, other threads:[~2023-01-12 10:40 UTC | newest]

Thread overview: 41+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-01-05  7:56 bug#60568: [FR] 30.0.50; Help buffers and function bodies for generated functions Ihor Radchenko
2023-01-05  8:09 ` Eli Zaretskii
2023-01-05  8:20   ` Ihor Radchenko
2023-01-05  8:32     ` Eli Zaretskii
2023-01-05 17:04       ` Jean Louis
2023-01-05 17:03   ` Jean Louis
2023-01-05  9:40 ` Gregory Heytings
2023-01-05  9:52   ` Gregory Heytings
2023-01-05 10:45 ` Daniel Martín via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-01-05 10:52   ` Ihor Radchenko
2023-01-05 11:20   ` Eli Zaretskii
2023-01-05 12:33     ` Gregory Heytings
2023-01-05 14:16       ` Eli Zaretskii
2023-01-05 14:27         ` Gregory Heytings
2023-01-05 15:10           ` Eli Zaretskii
2023-01-05 15:13             ` Gregory Heytings
2023-01-05 16:49               ` Eli Zaretskii
2023-01-05 20:44                 ` Gregory Heytings
2023-01-06  6:35                   ` Eli Zaretskii
2023-01-06  9:11                     ` Gregory Heytings
2023-01-06 17:27                       ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-01-06 22:52                         ` Gregory Heytings
2023-01-07  0:36                           ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-01-07  6:55                             ` Eli Zaretskii
2023-01-07  9:42                               ` Gregory Heytings
2023-01-07 13:38                                 ` Ihor Radchenko
2023-01-07 14:00                                   ` Eli Zaretskii
2023-01-07 14:04                                   ` Gregory Heytings
2023-01-07 15:07                                     ` Ihor Radchenko
2023-01-07 15:14                                       ` Eli Zaretskii
2023-01-07 15:19                                         ` Ihor Radchenko
2023-01-07 15:23                                           ` Eli Zaretskii
2023-01-07 17:59                                             ` Eli Zaretskii
2023-01-07 13:14                               ` Ihor Radchenko
2023-01-07 13:55                                 ` Eli Zaretskii
2023-01-05 17:00 ` Jean Louis
2023-01-06  8:39   ` Ihor Radchenko
2023-01-06 16:44 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-01-07 11:32   ` Ihor Radchenko
2023-01-07 15:44     ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-01-12 10:40       ` Ihor Radchenko

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).