From: Eli Zaretskii <eliz@gnu.org>
Date: Fri, 25 Nov 2016 09:44:24 +0000 (+0200)
Subject: Improve documentation of 'current-word'
X-Git-Tag: emacs-25.1.90~12
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=a6213ce;p=emacs.git

Improve documentation of 'current-word'

* lisp/simple.el (current-word): Clarify and improve the doc
string.  (Bug#24979)
---

diff --git a/lisp/simple.el b/lisp/simple.el
index dd2f0659220..295f8c63867 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -6832,13 +6832,18 @@ With argument ARG, do this that many times."
   (kill-word (- arg)))
 
 (defun current-word (&optional strict really-word)
-  "Return the symbol or word that point is on (or a nearby one) as a string.
+  "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 symbol or word.  In all cases the value can be nil
-if there is no word nearby.
-The function, belying its name, normally finds a symbol.
-If optional arg REALLY-WORD is non-nil, it finds just a word."
+
+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."
   (save-excursion
     (let* ((oldpoint (point)) (start (point)) (end (point))
 	   (syntaxes (if really-word "w" "w_"))