GNU bug report logs - #44582
26.3; doc strings of functions `isearch--state-*' are too long

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 44582 in the body.
You can then email your comments to 44582 AT debbugs.gnu.org in the normal way.

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

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

From: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 26.3; doc strings of functions `isearch--state-*' are too long
Date: Wed, 11 Nov 2020 10:39:32 -0800 (PST)

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''

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

From: Juri Linkov <juri <at> linkov.net>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 44582 <at> debbugs.gnu.org
Subject: Re: bug#44582: 26.3; doc strings of functions `isearch--state-*'
 are too long
Date: Thu, 12 Nov 2020 09:27:15 +0200

tags 44582 fixed
close 44582 27.1
quit

> For example: `C-h f isearch--state-case-fold-search':
>
> That "Access slot" line is 517 chars long!
>
> In GNU Emacs 26.3 (build 1, x86_64-w64-mingw32)

This has been fixed for a long time in the released version 27.1,
but you are still reporting bugs for the old version.

Previous Next

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