From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Lars Magne Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#8682: 24.0.50; doc strings of `isearch-mode', `isearch-forward', etc. Date: Fri, 15 Jul 2011 15:40:06 +0200 Message-ID: References: NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: dough.gmane.org 1310739276 6706 80.91.229.12 (15 Jul 2011 14:14:36 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Fri, 15 Jul 2011 14:14:36 +0000 (UTC) Cc: 8682@debbugs.gnu.org To: "Drew Adams" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Jul 15 16:14:29 2011 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([140.186.70.17]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1Qhj9w-0003pc-52 for geb-bug-gnu-emacs@m.gmane.org; Fri, 15 Jul 2011 16:14:28 +0200 Original-Received: from localhost ([::1]:56180 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Qhj9v-0007di-AE for geb-bug-gnu-emacs@m.gmane.org; Fri, 15 Jul 2011 10:14:27 -0400 Original-Received: from eggs.gnu.org ([140.186.70.92]:35109) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QhilO-0000rK-OF for bug-gnu-emacs@gnu.org; Fri, 15 Jul 2011 09:49:10 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1QhilK-00062z-Md for bug-gnu-emacs@gnu.org; Fri, 15 Jul 2011 09:49:06 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:51628) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QhilK-00062n-6M for bug-gnu-emacs@gnu.org; Fri, 15 Jul 2011 09:49:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.69) (envelope-from ) id 1QhilJ-0007P1-OH; Fri, 15 Jul 2011 09:49:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Magne Ingebrigtsen Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 15 Jul 2011 13:49:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 8682 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: notabug Original-Received: via spool by 8682-submit@debbugs.gnu.org id=B8682.131073768728387 (code B ref 8682); Fri, 15 Jul 2011 13:49:01 +0000 Original-Received: (at 8682) by debbugs.gnu.org; 15 Jul 2011 13:48:07 +0000 Original-Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QhikN-0007N1-BF for submit@debbugs.gnu.org; Fri, 15 Jul 2011 09:48:07 -0400 Original-Received: from hermes.netfonds.no ([80.91.224.195]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QhikE-0007ME-Av for 8682@debbugs.gnu.org; Fri, 15 Jul 2011 09:47:58 -0400 Original-Received: from cm-84.215.51.58.getinternet.no ([84.215.51.58] helo=quimbies.gnus.org) by hermes.netfonds.no with esmtpsa (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.72) (envelope-from ) id 1Qhik3-0002F0-4a; Fri, 15 Jul 2011 15:47:43 +0200 In-Reply-To: (Drew Adams's message of "Tue, 17 May 2011 07:25:05 -0700") User-Agent: Gnus/5.110018 (No Gnus v0.18) Emacs/24.0.50 (gnu/linux) X-Now-Playing: Joni Mitchell's _Ladies of the Canyon_: "The Circle Game" X-Hashcash: 1:23:110715:8682@debbugs.gnu.org::SChQOFAlhIIfoNzn:000000000000000000000000000000000000000008d3w X-Hashcash: 1:23:110715:drew.adams@oracle.com::K2LMkAfVCu+wZYge:0000000000000000000000000000000000000000QA9A X-MailScanner-ID: 1Qhik3-0002F0-4a MailScanner-NULL-Check: 1311342463.23962@mFGHXHsEsklUdFFgZ209vQ X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Resent-Date: Fri, 15 Jul 2011 09:49:01 -0400 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-Received-From: 140.186.70.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:49134 Archived-At: "Drew Adams" writes: > 1. At a minimum, the doc string of `isearch-mode' should say something > like this: > > FORWARD non-nil means forward search; nil means backward search. > REGEXP t means regexp search; nil means literal search. > OP-FUN means ??????? > RECURSIVE-EDIT non-nil means recursive edit for a modal search. > WORD-P non-nil means word search; nil means ignore word boundaries. It's an internal function. If you're not an isearch hacker, you'll never see it, and if you are, you will know what those parameters mean. The only thing that's useful in that doc string is the thing that's already there, and which you want removed: > And you can remove this sentence from the doc string - a function's doc > should, in general, not mention callers: > > "It is called by the function `isearch-forward' and other related > functions." > 2. Doc strings of `isearch-forward' etc. also need to describe their > args. E.g. > > Non-interactively: > REGEXP-P means... > NO-RECURSIVE-EDIT means... I think any reasonable person would guess that REGEXP-P means "it's a regexp", and NO-RECURSIVE-EDIT means "we're not in a recursive edit". So I'm closing this report. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog http://lars.ingebrigtsen.no/