diff options
| author | Alex Branham <alex.branham@gmail.com> | 2019-03-25 20:49:01 -0500 |
|---|---|---|
| committer | Alex Branham <alex.branham@gmail.com> | 2019-04-05 19:48:21 -0500 |
| commit | 10cd65878c741d2a22a1f2c36c54fcad4e516f72 (patch) | |
| tree | e510f8a15aca9a672b6f889a3f5b48650f17f2db | |
| parent | 01dc2da75ba11f8ddb1ac1802a8c5a7f0caea975 (diff) | |
| download | emacs-10cd65878c741d2a22a1f2c36c54fcad4e516f72.tar.gz | |
Update documentation for indent-relative functions
* lisp/indent.el (indent-relative): Document what happens when there
is no previous nonblank line.
* doc/lispref/text.texi (Relative Indent): Document
indent-relative-first-indent-point instead of obsolete
indent-relative-maybe. Fix documentation of which argument from
'indent-relative' is used.
Bug#34858
| -rw-r--r-- | doc/lispref/text.texi | 4 | ||||
| -rw-r--r-- | lisp/indent.el | 5 |
2 files changed, 5 insertions, 4 deletions
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 86f9fa0e5f5..1ef836b8f94 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi @@ -2577,11 +2577,11 @@ The quick brown fox jum @point{}ped. @end example @end deffn -@deffn Command indent-relative-maybe +@deffn Command indent-relative-first-indent-point @comment !!SourceFile indent.el This command indents the current line like the previous nonblank line, by calling @code{indent-relative} with @code{t} as the -@var{unindented-ok} argument. The return value is unpredictable. +@var{first-only} argument. The return value is unpredictable. If the previous nonblank line has no indent points beyond the current column, this command does nothing. diff --git a/lisp/indent.el b/lisp/indent.el index f3d3158faa0..bf87d6af760 100644 --- a/lisp/indent.el +++ b/lisp/indent.el @@ -600,8 +600,9 @@ considered. If the previous nonblank line has no indent points beyond the column point starts at, then `tab-to-tab-stop' is done, if both -FIRST-ONLY and UNINDENTED-OK are nil, otherwise nothing is done -in this case. +FIRST-ONLY and UNINDENTED-OK are nil, otherwise nothing is done. +If there isn't a previous nonblank line and UNINDENTED-OK is nil, +call `tab-to-tab-stop'. See also `indent-relative-first-indent-point'." (interactive "P") |