Doc fix for forward-word and backward-word.

* doc/lispref/positions.texi (Word Motion): Remove redundant sentence.
* lisp/simple.el (backward-word): Mention the optional argument.
* src/syntax.c (forward_word): Mention the optional argument.
This commit is contained in:
Xue Fuqiao 2013-08-13 22:26:39 +08:00
parent 956720afe4
commit f73f4ce69f
6 changed files with 16 additions and 4 deletions

View file

@ -1,3 +1,7 @@
2013-08-13 Xue Fuqiao <xfq.free@gmail.com>
* positions.texi (Word Motion): Remove redundant sentence.
2013-08-13 Glenn Morris <rgm@gnu.org>
* lists.texi (List Elements):

View file

@ -191,8 +191,8 @@ whether a given character is part of a word. @xref{Syntax Tables}.
@deffn Command forward-word &optional count
This function moves point forward @var{count} words (or backward if
@var{count} is negative). If @var{count} is @code{nil}, it moves
forward one word.
@var{count} is negative). If @var{count} is omitted or @code{nil}, it
defaults to 1.
``Moving one word'' means moving until point crosses a
word-constituent character and then encounters a word-separator
@ -210,7 +210,7 @@ If @code{inhibit-field-text-motion} is non-@code{nil},
this function ignores field boundaries.
In an interactive call, @var{count} is specified by the numeric prefix
argument. If @var{count} is omitted or @code{nil}, it defaults to 1.
argument.
@end deffn
@deffn Command backward-word &optional count

View file

@ -1,3 +1,7 @@
2013-08-13 Xue Fuqiao <xfq.free@gmail.com>
* simple.el (backward-word): Mention the optional argument.
2013-08-13 Stefan Monnier <monnier@iro.umontreal.ca>
* frameset.el (frameset--make): Rename constructor from make-frameset.

View file

@ -3338,6 +3338,7 @@ extract characters that are special to a buffer, and should not
be copied into other buffers."
(funcall filter-buffer-substring-function beg end delete))
;; FIXME: `with-wrapper-hook' is obsolete
(defun buffer-substring--filter (beg end &optional delete)
(with-wrapper-hook filter-buffer-substring-functions (beg end delete)
(cond
@ -5670,7 +5671,8 @@ current object."
(defun backward-word (&optional arg)
"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."
(interactive "^p")
(forward-word (- (or arg 1))))

View file

@ -1,5 +1,6 @@
2013-08-13 Xue Fuqiao <xfq.free@gmail.com>
* syntax.c (forward_word):
* cmds.c (forward_char, backward_char): Mention the optional argument.
2013-08-13 Dmitry Antipov <dmantipov@yandex.ru>

View file

@ -1464,6 +1464,7 @@ scan_words (register ptrdiff_t from, register EMACS_INT count)
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