all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 33164@debbugs.gnu.org
Subject: bug#33164: 26.1; Compiled function information in *Help*
Date: Fri, 26 Oct 2018 08:05:39 -0700 (PDT)	[thread overview]
Message-ID: <cb085600-e3fa-4827-9f6a-876976721add@default> (raw)

emacs -Q

C-h v region-extract-function tells me:

region-extract-function is a variable defined in 'simple.el'.
Its value is #f(compiled-function (method) #<bytecode 0x1001ae2e9>)
...

There is a link to `simple.el'.  And the #<bytecode...> is also a link,
to the disassembled byte-code.

This is a bit more helpful than what we had in Emacs 24 (which was the
byte-code, printed).

But it is less helpful than what we had back in Emacs 23, which printed
the name or the lambda expression of the function that is the value of
the variable.  Examples:

 comment-line-break-function is a variable defined in `simple.el'.
 Its value is comment-indent-new-line


 completion-annotate-function is a variable defined in `minibuffer.el'.
 Its value is (lambda (var)
                (and (custom-variable-p (intern-soft var))
                "  (option)"))

Such description provided lots of helpful information, and we've lost
that now.

I guess this comes from eager macroexpansion (?).  But is there no way
for our help system to know what the function name or original lambda
expression is, and print that?

Yes, it would be helpful for it to _also_ provide the info that the
value is actually the byte-compilation of that function, when that is
the case, and to provide a link to the disassembly of that byte-code.

But just showing the byte code, even disassembled, is not so helpful.
What if a user wants to go to the function definition, to use it as a
model for defining a new value for the variable or just to study it?

Our help system should not become _less_ helpful just because we find
ways to optimize Emacs or make other improvements.  From a help
perspective, this is a step backward for users.

But maybe I'm missing something?  Is there currently some way to get to
the source code defining the function that is the variable value?


In GNU Emacs 26.1 (build 1, x86_64-w64-mingw32)
 of 2018-05-30 built on CIRROCUMULUS
Repository revision: 07f8f9bc5a51f5aa94eb099f3e15fbe0c20ea1ea
Windowing system distributor 'Microsoft Corp.', version 10.0.16299





             reply	other threads:[~2018-10-26 15:05 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-10-26 15:05 Drew Adams [this message]
2018-10-28 13:27 ` bug#33164: 26.1; Compiled function information in *Help* Noam Postavsky
2018-10-28 14:17   ` Drew Adams
2021-06-23 14:05   ` bug#33164: Compiled function value " Lars Ingebrigtsen

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=cb085600-e3fa-4827-9f6a-876976721add@default \
    --to=drew.adams@oracle.com \
    --cc=33164@debbugs.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.