bug#40491: 27.0.90; Help text of `defun-declarations-alist' is not understandable

bug#40491: 27.0.90; Help text of `defun-declarations-alist' is not understandable

[Philipp Stephani]

C-h f defun-declarations-alist RET gives:

defun-declarations-alist is a variable defined in ‘byte-run.el’.
Its value is shown below.

  Probably introduced at or before Emacs version 24.3.

Documentation:
List associating function properties to their macro expansion.
Each element of the list takes the form (PROP FUN) where FUN is
a function.  For each (PROP . VALUES) in a function’s declaration,
the FUN corresponding to PROP is called with the function name,
the function’s arglist, and the VALUES and should return the code to use
to set this property.

This is used by ‘declare’.

Value:
((gv-setter #f(compiled-function
	       (&rest args2)
	       #<bytecode 0x1feefa44b019>))
 (gv-expander #f(compiled-function
		 (&rest args2)
		 #<bytecode 0x1feefa43ebc5>))
 (advertised-calling-convention #f(compiled-function
				   (f args arglist when)
				   #<bytecode 0x1feefa43eaeb>))
 (obsolete #f(compiled-function
	      (f args new-name when)
	      #<bytecode 0x1feefa43eaad>))
 (interactive-only #f(compiled-function
		      (f args instead)
		      #<bytecode 0x1feefa43ea79>))
 (pure #f(compiled-function
	  (f args val)
	  #<bytecode 0x1feefa43ea45>)
       "If non-nil, the compiler can replace calls with their return value.
This may shift errors from run-time to compile-time.")
 (side-effect-free #f(compiled-function
		      (f args val)
		      #<bytecode 0x1feefa43ea05>)
		   "If non-nil, calls can be ignored if their value is unused.
If `error-free', drop calls even if `byte-compile-delete-errors' is nil.")
 (compiler-macro #f(compiled-function
		    (f args compiler-function)
		    #<bytecode 0x1feefa43e919>))
 (doc-string #f(compiled-function
		(f args pos)
		#<bytecode 0x1feefa43e8e5>))
 (indent #f(compiled-function
	    (f args val)
	    #<bytecode 0x1feefa43e8b1>)))


Showing byte-compiled functions in help texts isn't useful.  The default
value of defun-declarations-alist (and all other public variables and
constants) should only contain named function symbols, not lambda
objects.


In GNU Emacs 27.0.90 (build 2, x86_64-pc-linux-gnu, GTK+ Version 3.24.12)
 of 2020-04-05
Repository revision: f8607d3c03544afbe32c6bd324c287db305e569e
Repository branch: emacs-27
Windowing system distributor 'The X.Org Foundation', version 11.0.12004000
System Description: Debian GNU/Linux rodete

Recent messages:
For information about GNU Emacs and the GNU system, type C-h C-a.

Configured using:
 'configure --enable-gcc-warnings=warn-only
 --enable-gtk-deprecation-warnings --without-pop --with-mailutils
 --enable-checking --enable-check-lisp-object-type --with-modules
 'CFLAGS=-O0 -ggdb3''

Configured features:
XPM JPEG TIFF GIF PNG SOUND DBUS GSETTINGS GLIB NOTIFY INOTIFY
LIBSELINUX GNUTLS FREETYPE HARFBUZZ XFT ZLIB TOOLKIT_SCROLL_BARS GTK3
X11 XDBE XIM MODULES THREADS PDUMPER GMP

Important settings:
  value of $LANG: en_US.UTF-8
  locale-coding-system: utf-8-unix

Major mode: Lisp Interaction

Minor modes in effect:
  tooltip-mode: t
  global-eldoc-mode: t
  eldoc-mode: t
  electric-indent-mode: t
  mouse-wheel-mode: t
  tool-bar-mode: t
  menu-bar-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  blink-cursor-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t
  line-number-mode: t
  transient-mark-mode: t

Load-path shadows:
None found.

Features:
(shadow sort mail-extr emacsbug message rmc dired dired-loaddefs
format-spec rfc822 mml easymenu mml-sec epa epg epg-config gnus-util
rmail rmail-loaddefs text-property-search time-date mm-decode mm-bodies
mm-encode mail-parse rfc2231 mailabbrev gmm-utils mailheader sendmail
rfc2047 rfc2045 ietf-drums mm-util mail-prsvr mail-utils phst skeleton
derived edmacro kmacro pcase ffap thingatpt url-parse auth-source cl-seq
eieio eieio-core cl-macs eieio-loaddefs password-cache json map url-vars
subr-x rx gnutls puny seq byte-opt gv bytecomp byte-compile cconv dbus
xml cl-loaddefs cl-lib tooltip eldoc electric uniquify ediff-hook
vc-hooks lisp-float-type mwheel term/x-win x-win term/common-win x-dnd
tool-bar dnd fontset image regexp-opt fringe tabulated-list replace
newcomment text-mode elisp-mode lisp-mode prog-mode register page
tab-bar menu-bar rfn-eshadow isearch timer select scroll-bar mouse
jit-lock font-lock syntax facemenu font-core term/tty-colors frame
minibuffer cl-generic cham georgian utf-8-lang misc-lang vietnamese
tibetan thai tai-viet lao korean japanese eucjp-ms cp51932 hebrew greek
romanian slovak czech european ethiopic indian cyrillic chinese
composite charscript charprop case-table epa-hook jka-cmpr-hook help
simple abbrev obarray cl-preloaded nadvice loaddefs button faces
cus-face macroexp files text-properties overlay sha1 md5 base64 format
env code-pages mule custom widget hashtable-print-readable backquote
threads dbusbind inotify dynamic-setting system-font-setting
font-render-setting move-toolbar gtk x-toolkit x multi-tty
make-network-process emacs)

Memory information:
((conses 16 60676 8698)
 (symbols 48 8241 1)
 (strings 32 21018 1891)
 (string-bytes 1 684588)
 (vectors 16 12142)
 (vector-slots 8 169092 5912)
 (floats 8 25 25)
 (intervals 56 202 0)
 (buffers 1000 12))

-- 
Google Germany GmbH
Erika-Mann-Straße 33
80636 München

Registergericht und -nummer: Hamburg, HRB 86891
Sitz der Gesellschaft: Hamburg
Geschäftsführer: Paul Manicle, Halimah DeLaine Prado

If you received this communication by mistake, please don’t forward it to
anyone else (it may contain confidential or privileged information), please
erase all copies of it, including all attachments, and please let the sender
know it went to the wrong person.  Thanks.

bug#40491: 27.0.90; Help text of `defun-declarations-alist' is not understandable

[Philipp Stephani]

Am Di., 7. Apr. 2020 um 19:04 Uhr schrieb Philipp Stephani
<p.stephani2@gmail.com>:
>
>

>
> Showing byte-compiled functions in help texts isn't useful.  The default
> value of defun-declarations-alist (and all other public variables and
> constants) should only contain named function symbols, not lambda
> objects.
>

If people agree with this, I can fix some of the variable values.

bug#40491: 27.0.90; Help text of `defun-declarations-alist' is not understandable

[Philipp Stephani]

Am Di., 7. Apr. 2020 um 19:31 Uhr schrieb Philipp Stephani
<p.stephani2@gmail.com>:
>
> Am Di., 7. Apr. 2020 um 19:04 Uhr schrieb Philipp Stephani
> <p.stephani2@gmail.com>:
> >
> >
>
> >
> > Showing byte-compiled functions in help texts isn't useful.  The default
> > value of defun-declarations-alist (and all other public variables and
> > constants) should only contain named function symbols, not lambda
> > objects.
> >
>
> If people agree with this, I can fix some of the variable values.

Fixed in commit 4f197a5e79.