GNU bug report logs - #8678
24.0.50; `isearch-barrier' referred to in doc string, but it has no doc itself

Previous Next

Package: emacs;

Reported by: "Drew Adams" <drew.adams <at> oracle.com>

Date: Mon, 16 May 2011 17:59:01 UTC

Severity: minor

Tags: fixed

Found in version 24.0.50

Fixed in version 24.1

Done: Lars Magne Ingebrigtsen <larsi <at> gnus.org>

Bug is archived. No further changes may be made.

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

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

View this report as an mbox folder, status mbox, maintainer mbox

Report forwarded to owner <at> debbugs.gnu.org, bug-gnu-emacs <at> gnu.org:
bug#8678; Package emacs. (Mon, 16 May 2011 17:59:01 GMT) Full text and rfc822 format available.
Acknowledgement sent to "Drew Adams" <drew.adams <at> oracle.com>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Mon, 16 May 2011 17:59:02 GMT) Full text and rfc822 format available.

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: 24.0.50;
	`isearch-barrier' referred to in doc string, but it has no doc itself
Date: Mon, 16 May 2011 10:58:35 -0700

There are many internal variables in isearch.el that have no doc strings
and no comments that would help communicate the design (intention) for
readers of the code.  I wish this info were added.
 
At the very least, a doc string is needed for `isearch-barrier', because
it is referred to in the doc string of `isearch-fallback'.  IOW, we are
using it to explain something else, yet it is an unknown.
 

In GNU Emacs 24.0.50.1 (i386-mingw-nt5.1.2600)
 of 2011-05-10 on 3249CTO
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.5) --no-opt --cflags
-Ic:/build/include'
Added tag(s) fixed. Request was from Lars Magne Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Fri, 15 Jul 2011 13:35:02 GMT) Full text and rfc822 format available.
bug marked as fixed in version 24.1, send any further explanations to 8678 <at> debbugs.gnu.org and "Drew Adams" <drew.adams <at> oracle.com> Request was from Lars Magne Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Fri, 15 Jul 2011 13:35:02 GMT) Full text and rfc822 format available.
Information forwarded to owner <at> debbugs.gnu.org, bug-gnu-emacs <at> gnu.org:
bug#8678; Package emacs. (Fri, 15 Jul 2011 13:48:06 GMT) Full text and rfc822 format available.

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

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 8678 <at> debbugs.gnu.org
Subject: Re: 24.0.50;
	`isearch-barrier' referred to in doc string, but it has no doc itself
Date: Fri, 15 Jul 2011 15:34:14 +0200

"Drew Adams" <drew.adams <at> oracle.com> writes:

> At the very least, a doc string is needed for `isearch-barrier', because
> it is referred to in the doc string of `isearch-fallback'.  IOW, we are
> using it to explain something else, yet it is an unknown.

I almost removed the mention from the doc string of `isearch-fallback'
instead, since it seemed pretty irrelevant.

But I added a doc string to the variable instead.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/
bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Sat, 13 Aug 2011 11:24:05 GMT) Full text and rfc822 format available.
This bug report was last modified 12 years and 284 days ago.

Previous Next

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