From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Kevin Rodgers Newsgroups: gmane.emacs.devel Subject: Re: Improving docstring for defface flyspell-duplicate Date: Tue, 24 Jan 2006 15:15:40 -0700 Message-ID: References: <17366.24376.217183.913015@chlr5836.ch.intel.com> NNTP-Posting-Host: main.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit X-Trace: sea.gmane.org 1138144641 17025 80.91.229.2 (24 Jan 2006 23:17:21 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Tue, 24 Jan 2006 23:17:21 +0000 (UTC) Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Wed Jan 25 00:17:19 2006 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1F1XPT-0008EQ-Jw for ged-emacs-devel@m.gmane.org; Wed, 25 Jan 2006 00:17:11 +0100 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1F1XS6-0004vG-0R for ged-emacs-devel@m.gmane.org; Tue, 24 Jan 2006 18:19:54 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1F1X61-0006Qb-E5 for emacs-devel@gnu.org; Tue, 24 Jan 2006 17:57:05 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1F1WZC-0001il-GP for emacs-devel@gnu.org; Tue, 24 Jan 2006 17:24:04 -0500 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1F1WZA-0001WC-KU for emacs-devel@gnu.org; Tue, 24 Jan 2006 17:23:08 -0500 Original-Received: from [80.91.229.2] (helo=ciao.gmane.org) by monty-python.gnu.org with esmtps (TLS-1.0:RSA_AES_256_CBC_SHA:32) (Exim 4.52) id 1F1WSz-00050Y-8s for emacs-devel@gnu.org; Tue, 24 Jan 2006 17:16:45 -0500 Original-Received: from list by ciao.gmane.org with local (Exim 4.43) id 1F1WST-0000tS-UC for emacs-devel@gnu.org; Tue, 24 Jan 2006 23:16:14 +0100 Original-Received: from 207.167.42.60 ([207.167.42.60]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Tue, 24 Jan 2006 23:16:13 +0100 Original-Received: from ihs_4664 by 207.167.42.60 with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Tue, 24 Jan 2006 23:16:13 +0100 X-Injected-Via-Gmane: http://gmane.org/ Original-To: emacs-devel@gnu.org Original-Lines: 64 Original-X-Complaints-To: usenet@sea.gmane.org X-Gmane-NNTP-Posting-Host: 207.167.42.60 User-Agent: Mozilla Thunderbird 0.9 (X11/20041105) X-Accept-Language: en-us, en In-Reply-To: <17366.24376.217183.913015@chlr5836.ch.intel.com> X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:49499 Archived-At: Andrew M. Scott wrote: > The docstring for defface flyspell-duplicate in flyspell.el says: > > "Face used for marking a misspelled word that appears twice in the > buffer. > > Replacing "twice" above with "two or more times" would better reflect > the current behavior of the code How about "more than once"? But both our suggestions make that sentence run longer than an 80-character line when indented. I think that "used for marking" is odd as well (the doc string for flyspell-incorrect is similar). How about "used to display"? Finally, what does "appears" mean? It certainly doesn't have anything to do with whether the duplicate word is in a visible portion of the buffer. I think "occurs" is better. Here's what I'd suggest: *** flyspell.el~ Tue Jan 24 15:02:56 2006 --- flyspell.el Tue Jan 24 15:12:36 2006 *************** *** 427,433 **** (defface flyspell-incorrect '((((class color)) (:foreground "OrangeRed" :bold t :underline t)) (t (:bold t))) ! "Face used for marking a misspelled word in Flyspell." :group 'flyspell) ;; backward-compatibility alias (put 'flyspell-incorrect-face 'face-alias 'flyspell-incorrect) --- 427,433 ---- (defface flyspell-incorrect '((((class color)) (:foreground "OrangeRed" :bold t :underline t)) (t (:bold t))) ! "Face used to display a misspelled word in Flyspell." :group 'flyspell) ;; backward-compatibility alias (put 'flyspell-incorrect-face 'face-alias 'flyspell-incorrect) *************** *** 435,441 **** (defface flyspell-duplicate '((((class color)) (:foreground "Gold3" :bold t :underline t)) (t (:bold t))) ! "Face used for marking a misspelled word that appears twice in the buffer. See also `flyspell-duplicate-distance'." :group 'flyspell) ;; backward-compatibility alias --- 435,441 ---- (defface flyspell-duplicate '((((class color)) (:foreground "Gold3" :bold t :underline t)) (t (:bold t))) ! "Face used to display subsequent occurrences of a misspelled word. See also `flyspell-duplicate-distance'." :group 'flyspell) ;; backward-compatibility alias > e.g. when I M-x flyspell-buffer, I regularly see more than two of the same > words colored with defface flyspell-duplicate. -- Kevin Rodgers