From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Robert Pluim Newsgroups: gmane.emacs.bugs Subject: bug#31135: 26.1; documentation of left-word and right-word are unclear Date: Fri, 13 Apr 2018 12:13:25 +0200 Message-ID: <87woxbmn22.fsf@gmail.com> References: <878t9se6pa.fsf@gmail.com> <83k1tc1i81.fsf@gnu.org> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Trace: blaine.gmane.org 1523614333 10279 195.159.176.226 (13 Apr 2018 10:12:13 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Fri, 13 Apr 2018 10:12:13 +0000 (UTC) Cc: 31135@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Apr 13 12:12:09 2018 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 1f6vge-0002Vz-Cf for geb-bug-gnu-emacs@m.gmane.org; Fri, 13 Apr 2018 12:12:08 +0200 Original-Received: from localhost ([::1]:40772 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1f6vij-0003D8-Fw for geb-bug-gnu-emacs@m.gmane.org; Fri, 13 Apr 2018 06:14:17 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:37208) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1f6viX-0003B7-Gu for bug-gnu-emacs@gnu.org; Fri, 13 Apr 2018 06:14:11 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1f6viU-0000Mr-B5 for bug-gnu-emacs@gnu.org; Fri, 13 Apr 2018 06:14:05 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:41216) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1f6viU-0000MZ-7A for bug-gnu-emacs@gnu.org; Fri, 13 Apr 2018 06:14:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1f6viT-0006EK-RP for bug-gnu-emacs@gnu.org; Fri, 13 Apr 2018 06:14:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Robert Pluim Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 13 Apr 2018 10:14:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 31135 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 31135-submit@debbugs.gnu.org id=B31135.152361441723911 (code B ref 31135); Fri, 13 Apr 2018 10:14:01 +0000 Original-Received: (at 31135) by debbugs.gnu.org; 13 Apr 2018 10:13:37 +0000 Original-Received: from localhost ([127.0.0.1]:49113 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f6vi5-0006Db-DY for submit@debbugs.gnu.org; Fri, 13 Apr 2018 06:13:37 -0400 Original-Received: from mail-wr0-f173.google.com ([209.85.128.173]:42184) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f6vi2-0006DN-3y for 31135@debbugs.gnu.org; Fri, 13 Apr 2018 06:13:34 -0400 Original-Received: by mail-wr0-f173.google.com with SMTP id s18so7771748wrg.9 for <31135@debbugs.gnu.org>; Fri, 13 Apr 2018 03:13:34 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:references:mail-copies-to:gmane-reply-to-list :date:in-reply-to:message-id:mime-version; bh=QoT7DdqQnEwUFztBWW6q9mpxrto+r01znD4A5rdLRdI=; b=FiGoYTFBc9PrZ1CJyhiUgXPgz4/NKpoANCXQHLX3Oa5Qodd/9FNqW77MV0TruelBM4 QEnEPTt6jFtxZ05HtMA07G079Y2du9k2EZ6+h7UxJt1TvA8WlNoP7H85Aq78LQSveDvj rYL1uD8VA6cwXuM/UuWgxnkG8CqIrKCmhlOMCzuJEdBLQkiY577DbN2wb3ph9WC/fpDi C1umIuGgbxHvgr2AvzeJT2R6GOZK0qbuJIXU8ksqVHW+H1NRlFMvKMkQLl2icZ4IEhFj JLTXUHCYDo/chs/CaxX3gJ4w4jS3knd08fC0S9VCxj6gCcwa7R7mDDeUrJ1FyEdYV7Yi WvNQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:references:mail-copies-to :gmane-reply-to-list:date:in-reply-to:message-id:mime-version; bh=QoT7DdqQnEwUFztBWW6q9mpxrto+r01znD4A5rdLRdI=; b=uZBYjL7Qp4iVo11Z6O8o4s8NYc5pufg+1JX5HkkHvLh1PUig03t5mwmZxs2Lnknfi1 ZpEV4JW4wTAFLC55QrTFPhP6/Y4WYZjbWrBOfifLQ8/V8sJut1VcfzN9XXqQbAFPP0bc 9CiH3b7/UgJi9LRiDF9lsgznAK0diiRLPml7Y+BrNHATTP2eTozd4K6oRULqNfLLTOQz MfP1M7ij2itloydhF3eblzTG6iMve9ucYISPIw9GvyBvemNrqvPbCEjIL4Be/NhX3TeM KYvzlUbKlNF9s3QsbAXdMpv6katUUfKwgbeWqrZ7XgO5Fh8JFe9Uy8UKrSp0bBl3MxiH ih3A== X-Gm-Message-State: ALQs6tDVeknor+8pfai4gkqowRN9fmhVMoThwGp7v1ZFfRVlWPF+8uLR 0itUrGBfKVGCcYFcU1wCL1BRIFYETck= X-Google-Smtp-Source: AIpwx49KQq2anNNMnM6kHBbDeoXRESiJkdko4Hf6UHJm85reF6OHPOs+MglQ82KkEKdCuJ762uwtgQ== X-Received: by 10.223.192.136 with SMTP id d8mr3108805wrf.268.1523614408003; Fri, 13 Apr 2018 03:13:28 -0700 (PDT) Original-Received: from rpluim-ubuntu ([149.5.228.1]) by smtp.gmail.com with ESMTPSA id j17sm1059704wmc.26.2018.04.13.03.13.26 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 13 Apr 2018 03:13:26 -0700 (PDT) Mail-Copies-To: never Gmane-Reply-To-List: yes In-Reply-To: <83k1tc1i81.fsf@gnu.org> (Eli Zaretskii's message of "Thu, 12 Apr 2018 19:51:10 +0300") 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:145243 Archived-At: --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Eli Zaretskii writes: >> From: Robert Pluim >> Date: Thu, 12 Apr 2018 18:21:37 +0200 >>=20 >> The documentation strings for left-word and right-word both say: >>=20 >> Value is normally t. >> If an edge of the buffer or a field boundary is reached, point is left= there >> there and the function returns nil. Field boundaries are not noticed >>=20 >>=20 >> 1. Which value is normally t? > > This is standard Emacs parlance: left-word is a function, and > functions generally return values in Lisp. So when we say "value is" > in the doc string of a function, we mean the value returned by that > function. > OK. I=CA=BCve seen 'return value is' used elsewhere, now it=CA=BCs clear. >> 2. 'there' is repeated in the second sentence. > > This kind of stuff needs to be fixed, no need to report it. I found a few more repetitions like this [1], all in lisp docstrings. emacs-26 branch, I imagine? --=-=-= Content-Type: text/x-diff Content-Disposition: inline; filename=0001-Remove-repetitions-in-documentation-strings.patch >From 60e10c503131f3088e901c7bbaaa53da816cf1e1 Mon Sep 17 00:00:00 2001 From: Robert Pluim Date: Fri, 13 Apr 2018 12:09:35 +0200 Subject: [PATCH] Remove repetitions in documentation strings To: emacs-devel@gnu.org * lisp/bindings.el (right-word): Remove repetition (left-word): Likewise. * lisp/image-mode.el (image-mode-as-hex): Likewise. * lisp/cedet/semantic/tag-ls.el (semantic-tag-similar-p): Likewise. * lisp/textmodes/reftex-vars.el (reftex-view-crossref-extra): Likewise --- lisp/bindings.el | 4 ++-- lisp/cedet/semantic/tag-ls.el | 2 +- lisp/image-mode.el | 2 +- lisp/textmodes/reftex-vars.el | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lisp/bindings.el b/lisp/bindings.el index e03b9e9a0c..3e202b9b78 100644 --- a/lisp/bindings.el +++ b/lisp/bindings.el @@ -807,7 +807,7 @@ right-word Value is normally t. If an edge of the buffer or a field boundary is reached, point is left there -there and the function returns nil. Field boundaries are not noticed +and the function returns nil. Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil." (interactive "^p") (if (eq (current-bidi-paragraph-direction) 'left-to-right) @@ -823,7 +823,7 @@ left-word Value is normally t. If an edge of the buffer or a field boundary is reached, point is left there -there and the function returns nil. Field boundaries are not noticed +and the function returns nil. Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil." (interactive "^p") (if (eq (current-bidi-paragraph-direction) 'left-to-right) diff --git a/lisp/cedet/semantic/tag-ls.el b/lisp/cedet/semantic/tag-ls.el index b9cce17669..39a4d9542e 100644 --- a/lisp/cedet/semantic/tag-ls.el +++ b/lisp/cedet/semantic/tag-ls.el @@ -134,7 +134,7 @@ semantic-tag-similar-p attributes, and IGNORABLE-ATTRIBUTES will augment this list. Note that even though :name is not an attribute, it can be used to -to indicate lax comparison of names via `semantic--tag-similar-names-p'") +indicate lax comparison of names via `semantic--tag-similar-names-p'") ;; Note: optional thing is because overloadable fcns don't handle this ;; quite right. diff --git a/lisp/image-mode.el b/lisp/image-mode.el index 1052ed9761..c0186f07a1 100644 --- a/lisp/image-mode.el +++ b/lisp/image-mode.el @@ -676,7 +676,7 @@ image-mode-as-hex to display an image file as the actual image. You can use `image-mode-as-hex' in `auto-mode-alist' when you want to -to display an image file as hex initially. +display an image file as hex initially. See commands `image-mode' and `image-minor-mode' for more information on these modes." diff --git a/lisp/textmodes/reftex-vars.el b/lisp/textmodes/reftex-vars.el index 01ee4f5fa4..11dbb8d570 100644 --- a/lisp/textmodes/reftex-vars.el +++ b/lisp/textmodes/reftex-vars.el @@ -1616,7 +1616,7 @@ reftex-view-crossref-extra MACRO-RE is matched against the macro. SEARCH-RE is the regexp used to search for cross references. `%s' in this regexp is replaced with -with the macro argument at point. HIGHLIGHT is an integer indicating +the macro argument at point. HIGHLIGHT is an integer indicating which subgroup of the match should be highlighted." :group 'reftex-viewing-cross-references :type '(repeat (group (regexp :tag "Macro Regexp ") -- 2.17.0.rc1.35.g90bbd502d --=-=-= Content-Type: text/plain Footnotes: [1] After getting far too distracted by the emacs-lisp reference manual --=-=-=--