From: Drew Adams <drew.adams@oracle.com>
To: 44582@debbugs.gnu.org
Subject: bug#44582: 26.3; doc strings of functions `isearch--state-*' are too long
Date: Wed, 11 Nov 2020 10:39:32 -0800 (PST) [thread overview]
Message-ID: <74141d8b-994e-4c89-a810-322f70a54759@default> (raw)
For example: `C-h f isearch--state-case-fold-search':
isearch--state-case-fold-search is a compiled Lisp function in
'isearch.el'.
(isearch--state-case-fold-search CL-X)
This function has a compiler macro 'isearch--state-case-fold-search--cmacro'.
Access slot "case-fold-search" of `(isearch--state (:constructor nil) (:copier nil) (:constructor isearch--get-state (&aux (string isearch-string) (message isearch-message) (point (point)) (success isearch-success) (forward isearch-forward) (other-end isearch-other-end) (word isearch-regexp-function) (error isearch-error) (wrapped isearch-wrapped) (barrier isearch-barrier) (case-fold-search isearch-case-fold-search) (pop-fun (if isearch-push-state-function (funcall isearch-push-state-function))))))' struct CL-X.
This function does not change global state, including the match data.
That "Access slot" line is 517 chars long!
Lest you say that no one should ever consult the doc of an "internal"
function (with which I strongly disagree, anyway), consider a command
that shows you, as completion candidates, doc strings of all function
names matching your input.
`apropos-function' itself compensates, by filling the value. But we
have a convention about doc-string line lengths, and 517 chars is, well
far beyond the limit.
In GNU Emacs 26.3 (build 1, x86_64-w64-mingw32)
of 2019-08-29
Repository revision: 96dd0196c28bc36779584e47fffcca433c9309cd
Windowing system distributor `Microsoft Corp.', version 10.0.18362
Configured using:
`configure --without-dbus --host=x86_64-w64-mingw32
--without-compress-install 'CFLAGS=-O2 -static -g3''
next reply other threads:[~2020-11-11 18:39 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-11 18:39 Drew Adams [this message]
2020-11-12 7:27 ` bug#44582: 26.3; doc strings of functions `isearch--state-*' are too long Juri Linkov
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=74141d8b-994e-4c89-a810-322f70a54759@default \
--to=drew.adams@oracle.com \
--cc=44582@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.