summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2016-02-10 20:30:12 +0200
committerEli Zaretskii <eliz@gnu.org>2016-02-10 20:30:12 +0200
commit4ef153b55a543e67dec280accb1b2a3543089060 (patch)
tree3ad7f0b0e26a5a32902363bca8bd999b4db3b15c /src
parent3ad05a0dc46093dd6b8958747a0475b8baba954f (diff)
downloademacs-4ef153b55a543e67dec280accb1b2a3543089060.tar.gz
Improve doc strings of 'forward/backward-word-strictly'
* lisp/simple.el (backward-word): Refer to 'backward-word-strictly' in the doc string. Suggested by Glenn Morris <rgm@gnu.org>. * lisp/subr.el (forward-word-strictly, backward-word-strictly): Mention 'subword-mode' in the doc strings. * src/syntax.c (Fforward_word): Refer to 'forward-word-strictly' in the doc string. (Bug#22560)
Diffstat (limited to 'src')
-rw-r--r--src/syntax.c12
1 files changed, 9 insertions, 3 deletions
diff --git a/src/syntax.c b/src/syntax.c
index 8b5cc1df407..7e988547675 100644
--- a/src/syntax.c
+++ b/src/syntax.c
@@ -1536,9 +1536,15 @@ DEFUN ("forward-word", Fforward_word, Sforward_word, 0, 1, "^p",
doc: /* Move point forward ARG words (backward if ARG is negative).
If ARG is omitted or nil, move point forward one word.
Normally returns t.
-If an edge of the buffer or a field boundary is reached, point is left there
-and the function returns nil. Field boundaries are not noticed if
-`inhibit-field-text-motion' is non-nil. */)
+If an edge of the buffer or a field boundary is reached, point is
+left there and the function returns nil. Field boundaries are not
+noticed if `inhibit-field-text-motion' is non-nil.
+
+The word boundaries are normally determined by the buffer's syntax
+table, but `find-word-boundary-function-table', such as set up
+by `subword-mode', can change that. If a Lisp program needs to
+move by words determined strictly by the syntax table, it should
+use `forward-word-strictly' instead. */)
(Lisp_Object arg)
{
Lisp_Object tmp;