diff options
| author |   Ulrich Müller <ulm@gentoo.org> | 2022-04-26 10:18:43 +0200 |
|---|---|---|
| committer | Ulrich Müller <ulm@gentoo.org> | 2022-04-26 10:18:43 +0200 |
| commit | f219b1c2f633f5f3bc00b02d1237c3cc345f7f26 (patch) | |
| tree | 56d133b2bcb6c3548627d6cefa422089b074cc9f /eclass-writing | |
| parent | bin/gen-eclass-html.sh: Don't show mailto links (diff) | |
| download | devmanual-f219b1c2f633f5f3bc00b02d1237c3cc345f7f26.tar.gz devmanual-f219b1c2f633f5f3bc00b02d1237c3cc345f7f26.tar.bz2 devmanual-f219b1c2f633f5f3bc00b02d1237c3cc345f7f26.zip | |
eclass-writing: Sentence ends should be followed by two spaces
Signed-off-by: Ulrich Müller <ulm@gentoo.org>
Diffstat (limited to 'eclass-writing')
| -rw-r--r-- | eclass-writing/text.xml | 10 |
1 files 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: <app-file> [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 <app-file> is installed as-is. +# the file. Otherwise <app-file> is installed as-is. domacosapp() { [[ -z "${1}" ]] && die "usage: domacosapp <file> [new file]" if use ppc-macos ; then |