Commit 4ef153b5 authored by Eli Zaretskii's avatar Eli Zaretskii

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)
parent 3ad05a0d
...@@ -6736,7 +6736,13 @@ current object." ...@@ -6736,7 +6736,13 @@ current object."
(defun backward-word (&optional arg) (defun backward-word (&optional arg)
"Move backward until encountering the beginning of a word. "Move backward until encountering the beginning of a word.
With argument ARG, do this that many times. With argument ARG, do this that many times.
If ARG is omitted or nil, move point backward one word." If ARG is omitted or nil, move point backward one word.
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 `backward-word-strictly' instead."
(interactive "^p") (interactive "^p")
(forward-word (- (or arg 1)))) (forward-word (- (or arg 1))))
......
...@@ -4137,7 +4137,8 @@ and the function returns nil. Field boundaries are not noticed if ...@@ -4137,7 +4137,8 @@ and the function returns nil. Field boundaries are not noticed if
`inhibit-field-text-motion' is non-nil. `inhibit-field-text-motion' is non-nil.
This function is like `forward-word', but it is not affected This function is like `forward-word', but it is not affected
by `find-word-boundary-function-table'. It is also not interactive." by `find-word-boundary-function-table' (as set up by
e.g. `subword-mode'). It is also not interactive."
(let ((find-word-boundary-function-table (let ((find-word-boundary-function-table
(if (char-table-p word-move-empty-char-table) (if (char-table-p word-move-empty-char-table)
word-move-empty-char-table word-move-empty-char-table
...@@ -4150,7 +4151,8 @@ With argument ARG, do this that many times. ...@@ -4150,7 +4151,8 @@ With argument ARG, do this that many times.
If ARG is omitted or nil, move point backward one word. If ARG is omitted or nil, move point backward one word.
This function is like `forward-word', but it is not affected This function is like `forward-word', but it is not affected
by `find-word-boundary-function-table'. It is also not interactive." by `find-word-boundary-function-table' (as set up by
e.g. `subword-mode'). It is also not interactive."
(let ((find-word-boundary-function-table (let ((find-word-boundary-function-table
(if (char-table-p word-move-empty-char-table) (if (char-table-p word-move-empty-char-table)
word-move-empty-char-table word-move-empty-char-table
......
...@@ -1536,9 +1536,15 @@ DEFUN ("forward-word", Fforward_word, Sforward_word, 0, 1, "^p", ...@@ -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). doc: /* Move point forward ARG words (backward if ARG is negative).
If ARG is omitted or nil, move point forward one word. If ARG is omitted or nil, move point forward one word.
Normally returns t. Normally returns t.
If an edge of the buffer or a field boundary is reached, point is left there If an edge of the buffer or a field boundary is reached, point is
and the function returns nil. Field boundaries are not noticed if left there and the function returns nil. Field boundaries are not
`inhibit-field-text-motion' is non-nil. */) 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 arg)
{ {
Lisp_Object tmp; Lisp_Object tmp;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment