From b2d99c0d0aaab4d0c7026a26393e22d66246a349 Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Mon, 1 Jul 2024 02:33:05 +0200 Subject: [PATCH] Improve `sentence-end-double-space` docstring * lisp/textmodes/paragraphs.el (sentence-end-double-space): Improve and expand docstring. --- lisp/textmodes/paragraphs.el | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/lisp/textmodes/paragraphs.el b/lisp/textmodes/paragraphs.el index af99a96e045..be741e6517b 100644 --- a/lisp/textmodes/paragraphs.el +++ b/lisp/textmodes/paragraphs.el @@ -118,8 +118,28 @@ text indented by a margin setting." (defcustom sentence-end-double-space t "Non-nil means a single space does not end a sentence. -This is relevant for filling. See also `sentence-end-without-period' -and `colon-double-space'. +This user option affects fill commands and sentence commands. + +If this variable is non-nil, Emacs considers a period followed by two +spaces or by a newline as the end of a sentence. This means that: + + 1. The fill commands will not break a line after a period followed + by just one space. + + 2. The sentence commands stop only for double spaces. + +If this variable is nil, Emacs considers a period followed by one space +or by a newline as the end of a sentence. This means that: + + 1. The fill commands will break a line after a period followed by + one space, and put just one space after each period. + + 2. The sentence commands stop for single spaces. + +For more details, see Info node `(emacs) Fill Commands' and Info +node `(emacs) Sentences'. + +See also `sentence-end-without-period' and `colon-double-space'. This value is used by the function `sentence-end' to construct the regexp describing the end of a sentence, when the value of the variable