From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#24979: 24.5; Doc string of `current-word' Date: Fri, 25 Nov 2016 11:52:24 +0200 Message-ID: <83fumf51k7.fsf@gnu.org> References: Reply-To: Eli Zaretskii NNTP-Posting-Host: blaine.gmane.org X-Trace: blaine.gmane.org 1480067603 25001 195.159.176.226 (25 Nov 2016 09:53:23 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Fri, 25 Nov 2016 09:53:23 +0000 (UTC) Cc: 24979-done@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Nov 25 10:53:15 2016 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cADBz-00057G-L0 for geb-bug-gnu-emacs@m.gmane.org; Fri, 25 Nov 2016 10:53:15 +0100 Original-Received: from localhost ([::1]:44936 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cADC3-0001gP-3X for geb-bug-gnu-emacs@m.gmane.org; Fri, 25 Nov 2016 04:53:19 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:37766) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cADBq-0001g8-9u for bug-gnu-emacs@gnu.org; Fri, 25 Nov 2016 04:53:10 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cADBm-0006Rj-8F for bug-gnu-emacs@gnu.org; Fri, 25 Nov 2016 04:53:06 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:53906) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1cADBm-0006RY-5G for bug-gnu-emacs@gnu.org; Fri, 25 Nov 2016 04:53:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1cADBl-0000N5-Ud for bug-gnu-emacs@gnu.org; Fri, 25 Nov 2016 04:53:01 -0500 Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-To: bug-gnu-emacs@gnu.org Resent-Date: Fri, 25 Nov 2016 09:53:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: cc-closed 24979 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Mail-Followup-To: 24979@debbugs.gnu.org, eliz@gnu.org, drew.adams@oracle.com Original-Received: via spool by 24979-done@debbugs.gnu.org id=D24979.14800675661399 (code D ref 24979); Fri, 25 Nov 2016 09:53:01 +0000 Original-Received: (at 24979-done) by debbugs.gnu.org; 25 Nov 2016 09:52:46 +0000 Original-Received: from localhost ([127.0.0.1]:41071 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cADBW-0000MV-BA for submit@debbugs.gnu.org; Fri, 25 Nov 2016 04:52:46 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:46686) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cADBV-0000MH-3v for 24979-done@debbugs.gnu.org; Fri, 25 Nov 2016 04:52:45 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cADBL-0006A6-PL for 24979-done@debbugs.gnu.org; Fri, 25 Nov 2016 04:52:39 -0500 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:58548) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cADBL-00069z-Lj; Fri, 25 Nov 2016 04:52:35 -0500 Original-Received: from 84.94.185.246.cable.012.net.il ([84.94.185.246]:2198 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_128_CBC_SHA1:128) (Exim 4.82) (envelope-from ) id 1cADBK-0006qz-M2; Fri, 25 Nov 2016 04:52:35 -0500 In-reply-to: (message from Drew Adams on Mon, 21 Nov 2016 10:24:56 -0800 (PST)) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.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" Xref: news.gmane.org gmane.emacs.bugs:126076 Archived-At: > Date: Mon, 21 Nov 2016 10:24:56 -0800 (PST) > From: Drew Adams > > This part of the doc string is wrong: > > The function, belying its name, normally finds a symbol. > > > 1. There is no "normally". Do you mean often? Usually? Sometimes? > (When?) "Normally" is GNU and Emacs parlance for "by default", and is usually (as in this case) followed by the description of the non-default use case. You will find gazillions of this in the documentation. > 2. It always returns a string, never a symbol. A symbol is a Lisp > object. If you mean that it often returns a string that has symbol, > not word, syntax, then say so. That does not mean that it returns a > symbol. Yes, the first line of the doc now says that it returns a > string. This means that the doc as a whole is currently confusing > and inconsistent. I think this is splitting hair, probably because "symbol" is ambiguous due to its being a Lisp object. E.g., if the doc string said Return the word at or near point, as a string. you wouldn't object, because "word" is not a Lisp object. Anyway, I modified the doc string to say "Return the word at or near point, as a string. The return value includes no text properties. If optional arg STRICT is non-nil, return nil unless point is within or adjacent to a word, otherwise look for a word within point's line. If there is no word anywhere on point's line, the value is nil regardless of STRICT. By default, this function treats as a single word any sequence of characters that have either word or symbol syntax. If optional arg REALLY-WORD is non-nil, only characters of word syntax can constitute a word." Thanks.