diff options
| author | Basil L. Contovounesios | 2019-07-17 13:05:42 +0100 |
|---|---|---|
| committer | Basil L. Contovounesios | 2019-10-08 00:10:19 +0100 |
| commit | 373ffc59317cb96e253a0b0939b921e9172b44ff (patch) | |
| tree | 8fbe9721a18f5f5e21ccc7932528075f82d45bbb /doc | |
| parent | 3f9ad4e725788dff5eaafc4678286c9386302a17 (diff) | |
| download | emacs-373ffc59317cb96e253a0b0939b921e9172b44ff.tar.gz emacs-373ffc59317cb96e253a0b0939b921e9172b44ff.zip | |
Clarify docs on newline and auto-fill-mode
* doc/lispref/text.texi (Commands for Insertion):
* lisp/simple.el (newline): Do not mention conditions specific to
'do-auto-fill' under documentation of 'newline' (bug#36702).
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/text.texi | 17 |
1 files changed, 10 insertions, 7 deletions
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 8d78a9b24ff..ef1d8ebc571 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi | |||
| @@ -545,25 +545,28 @@ Do not try substituting your own definition of | |||
| 545 | loop handles this function specially. | 545 | loop handles this function specially. |
| 546 | @end deffn | 546 | @end deffn |
| 547 | 547 | ||
| 548 | @deffn Command newline &optional number-of-newlines | 548 | @deffn Command newline &optional number-of-newlines interactive |
| 549 | This command inserts newlines into the current buffer before point. | 549 | This command inserts newlines into the current buffer before point. |
| 550 | If @var{number-of-newlines} is supplied, that many newline characters | 550 | If @var{number-of-newlines} is supplied, that many newline characters |
| 551 | are inserted. | 551 | are inserted. In an interactive call, @var{number-of-newlines} is the |
| 552 | numeric prefix argument. | ||
| 552 | 553 | ||
| 553 | @cindex newline and Auto Fill mode | 554 | @cindex newline and Auto Fill mode |
| 554 | This function calls @code{auto-fill-function} if the current column | 555 | This command calls @code{self-insert-command} to insert newlines, |
| 555 | number is greater than the value of @code{fill-column} and | 556 | which may subsequently break the preceding line by calling |
| 556 | @var{number-of-newlines} is @code{nil}. Typically what | 557 | @code{auto-fill-function} (@pxref{Auto Filling}). Typically what |
| 557 | @code{auto-fill-function} does is insert a newline; thus, the overall | 558 | @code{auto-fill-function} does is insert a newline; thus, the overall |
| 558 | result in this case is to insert two newlines at different places: one | 559 | result in this case is to insert two newlines at different places: one |
| 559 | at point, and another earlier in the line. @code{newline} does not | 560 | at point, and another earlier in the line. @code{newline} does not |
| 560 | auto-fill if @var{number-of-newlines} is non-@code{nil}. | 561 | auto-fill if @var{number-of-newlines} is non-@code{nil}. |
| 561 | 562 | ||
| 563 | This command does not run the hook @code{post-self-insert-hook} unless | ||
| 564 | called interactively or @var{interactive} is non-@code{nil}. | ||
| 565 | |||
| 562 | This command indents to the left margin if that is not zero. | 566 | This command indents to the left margin if that is not zero. |
| 563 | @xref{Margins}. | 567 | @xref{Margins}. |
| 564 | 568 | ||
| 565 | The value returned is @code{nil}. In an interactive call, @var{count} | 569 | The value returned is @code{nil}. |
| 566 | is the numeric prefix argument. | ||
| 567 | @end deffn | 570 | @end deffn |
| 568 | 571 | ||
| 569 | @defvar overwrite-mode | 572 | @defvar overwrite-mode |