summaryrefslogtreecommitdiff
path: root/doc/lispref/text.texi
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2020-10-28 12:47:00 +0100
committerLars Ingebrigtsen <larsi@gnus.org>2020-10-28 12:47:00 +0100
commit5de5b63e57d45330221c7f3c160b75fd7d02ef9e (patch)
treeb5921b6a7b2238f6dfcdb5753442bccc2396110a /doc/lispref/text.texi
parent63b8f25b88fcfe3198c15e5e78bdd075a7990cfe (diff)
downloademacs-5de5b63e57d45330221c7f3c160b75fd7d02ef9e.tar.gz
emacs-5de5b63e57d45330221c7f3c160b75fd7d02ef9e.tar.bz2
emacs-5de5b63e57d45330221c7f3c160b75fd7d02ef9e.zip
Document all parameters on `indent-relative'
* doc/lispref/text.texi (Relative Indent): Mention the FIRST-ONLY parameter (bug#39330).
Diffstat (limited to 'doc/lispref/text.texi')
-rw-r--r--doc/lispref/text.texi5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi
index 559b2b1c973..550e7feee2e 100644
--- a/doc/lispref/text.texi
+++ b/doc/lispref/text.texi
@@ -2566,7 +2566,7 @@ the beginning of the line (if @var{nochange-regexp} is non-@code{nil}).
This section describes two commands that indent the current line
based on the contents of previous lines.
-@deffn Command indent-relative &optional unindented-ok
+@deffn Command indent-relative &optional first-only unindented-ok
This command inserts whitespace at point, extending to the same
column as the next @dfn{indent point} of the previous nonblank line. An
indent point is a non-whitespace character following whitespace. The
@@ -2582,6 +2582,9 @@ nothing (if @var{unindented-ok} is non-@code{nil}) or calls
of the last column of a short line of text, this command ordinarily
moves point to the next tab stop by inserting whitespace.
+If @var{first-only} is non-@code{nil}, only the first indent point is
+considered.
+
The return value of @code{indent-relative} is unpredictable.
In the following example, point is at the beginning of the second