From: Stefan Kangas <stefankangas@gmail.com>
Date: Sat, 25 Jan 2020 15:21:06 +0000 (+0100)
Subject: Improve doc string of 'newline'
X-Git-Tag: emacs-27.0.90~98
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=568a560fce;p=emacs.git

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.
---

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.")
 
 (defun newline (&optional arg interactive)
   "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
-text-property `hard'.
-With ARG, insert that many newlines.
+With prefix argument ARG, insert that many newlines.
 
 If `electric-indent-mode' is enabled, this indents the final new line
 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
 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'."
   (interactive "*P\np")
   (barf-if-buffer-read-only)