]> git.eshelyaron.com Git - emacs.git/commitdiff
Document all parameters on `indent-relative'
authorLars Ingebrigtsen <larsi@gnus.org>
Wed, 28 Oct 2020 11:47:00 +0000 (12:47 +0100)
committerLars Ingebrigtsen <larsi@gnus.org>
Wed, 28 Oct 2020 11:47:00 +0000 (12:47 +0100)
* doc/lispref/text.texi (Relative Indent): Mention the FIRST-ONLY
parameter (bug#39330).

doc/lispref/text.texi

index 559b2b1c97378149a8a4cad21cd997fe41a0d45d..550e7feee2edb515dd34aab4f5ef88609b4d3f12 100644 (file)
@@ -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