[gentoo-commits] proj/devmanual:master commit in: eclass-writing/

[Ulrich Müller]

commit:     f219b1c2f633f5f3bc00b02d1237c3cc345f7f26
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Tue Apr 26 08:18:43 2022 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Apr 26 08:18:43 2022 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=f219b1c2

eclass-writing: Sentence ends should be followed by two spaces

Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>

 eclass-writing/text.xml | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml
index 22b973f..8c83dc2 100644
--- a/eclass-writing/text.xml
+++ b/eclass-writing/text.xml
@@ -172,6 +172,12 @@ in the tree or <c>pkgcheck scan --commits</c> to check for issues
 in your staged git commits.
 </p>
 
+<note>
+In eclass documentation, two spaces should be used after the end of each
+sentence (unless it is followed by a newline). This will help <c>groff</c>
+to properly break lines when generating eclass manpages.
+</note>
+
 </body>
 </section>
 
@@ -597,9 +603,9 @@ a single function, <c>domacosapp</c>.
 # @FUNCTION: domacosapp
 # @USAGE: &lt;app-file&gt; [new-file]
 # @DESCRIPTION:
-# Install the given .app file into the appropriate location. If
+# Install the given .app file into the appropriate location.  If
 # [new-file] is given, it will be used as the new (installed) name of
-# the file. Otherwise &lt;app-file&gt; is installed as-is.
+# the file.  Otherwise &lt;app-file&gt; is installed as-is.
 domacosapp() {
 	[[ -z "${1}" ]] &amp;&amp; die "usage: domacosapp &lt;file&gt; [new file]"
 	if use ppc-macos ; then