diff options
author | Eli Zaretskii <eliz@gnu.org> | 2016-11-25 11:44:24 +0200 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2016-11-25 11:44:24 +0200 |
commit | a6213ce4b3ab8435de80e01f6df7de261a0a8c87 (patch) | |
tree | 1a509c5788614848f2391b7e34b9569d5e700e79 | |
parent | 0828126934c89039383de845910c20f50e973837 (diff) | |
download | emacs-a6213ce4b3ab8435de80e01f6df7de261a0a8c87.tar.gz |
Improve documentation of 'current-word'
* lisp/simple.el (current-word): Clarify and improve the doc
string. (Bug#24979)
-rw-r--r-- | lisp/simple.el | 17 |
1 files changed, 11 insertions, 6 deletions
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_")) |