aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStefan Kangas2020-01-25 16:21:06 +0100
committerStefan Kangas2020-01-25 19:12:31 +0100
commit568a560fceda2afd8e0c91e3176e81718bfa5ead (patch)
treedf0822f6b0f8d2b7664a68ee1748935c23cea9a1
parent7f5069850529f37e44939ce612e20d85be25af5c (diff)
downloademacs-568a560fceda2afd8e0c91e3176e81718bfa5ead.tar.gz
emacs-568a560fceda2afd8e0c91e3176e81718bfa5ead.zip
Improve doc string of 'newline'
* 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.
-rw-r--r--lisp/simple.el7
1 files changed, 4 insertions, 3 deletions
diff --git a/lisp/simple.el b/lisp/simple.el
index 73aea415c77..00a706848bd 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -503,9 +503,7 @@ This hook is run by `delete-selection-uses-region-p', which see.")
503 503
504(defun newline (&optional arg interactive) 504(defun newline (&optional arg interactive)
505 "Insert a newline, and move to left margin of the new line if it's blank. 505 "Insert a newline, and move to left margin of the new line if it's blank.
506If option `use-hard-newlines' is non-nil, the newline is marked with the 506With prefix argument ARG, insert that many newlines.
507text-property `hard'.
508With ARG, insert that many newlines.
509 507
510If `electric-indent-mode' is enabled, this indents the final new line 508If `electric-indent-mode' is enabled, this indents the final new line
511that it adds, and reindents the preceding line. To just insert 509that it adds, and reindents the preceding line. To just insert
@@ -514,6 +512,9 @@ a newline, use \\[electric-indent-just-newline].
514If `auto-fill-mode' is enabled, this may cause automatic line 512If `auto-fill-mode' is enabled, this may cause automatic line
515breaking of the preceding line. A non-nil ARG inhibits this. 513breaking of the preceding line. A non-nil ARG inhibits this.
516 514
515If `use-hard-newlines' is enabled, the newline is marked with the
516text-property `hard'.
517
517A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'." 518A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
518 (interactive "*P\np") 519 (interactive "*P\np")
519 (barf-if-buffer-read-only) 520 (barf-if-buffer-read-only)