procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve doc string of 'newline'

Browse source 
* lisp/simple.el (newline): Doc fix.  Move 'use-hard-newlines' down,
since it's less important than the meaning of the prefix argument, and
is less frequently used than 'electric-indent-mode' and
'auto-fill-mode'.  Change the wording to no longer call it an
option.
This commit is contained in:
Stefan Kangas 2020-01-25 16:21:06 +01:00
parent 7f50698505
commit 568a560fce
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
lisp/simple.el
View file

@ -503,9 +503,7 @@ This hook is run by `delete-selection-uses-region-p', which see.")
(defun newline (&optional arg interactive) (defun newline (&optional arg interactive)
"Insert a newline, and move to left margin of the new line if it's blank. "Insert a newline, and move to left margin of the new line if it's blank.
If option `use-hard-newlines' is non-nil, the newline is marked with the With prefix argument ARG, insert that many newlines.
text-property `hard'.
With ARG, insert that many newlines.
If `electric-indent-mode' is enabled, this indents the final new line If `electric-indent-mode' is enabled, this indents the final new line
that it adds, and reindents the preceding line. To just insert that it adds, and reindents the preceding line. To just insert
@ -514,6 +512,9 @@ a newline, use \\[electric-indent-just-newline].
If `auto-fill-mode' is enabled, this may cause automatic line If `auto-fill-mode' is enabled, this may cause automatic line
breaking of the preceding line. A non-nil ARG inhibits this. breaking of the preceding line. A non-nil ARG inhibits this.
If `use-hard-newlines' is enabled, the newline is marked with the
text-property `hard'.
A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'." A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
(interactive "*P\np") (interactive "*P\np")
(barf-if-buffer-read-only) (barf-if-buffer-read-only)