[DRE-maint] Bug#1037106: asciidoctor: Some tips to improve the formatting quality of man pages
Bjarni Ingi Gislason
bjarniig at simnet.is
Sun Jun 4 23:19:54 BST 2023
Package: asciidoctor
Version: 2.0.18-2
Severity: minor
Dear Maintainer,
here are some observations about created man pages with asciidoctor.
####
Do not use '.sp' right after paragraphing macros like "SH".
####
Begin each sentence on a new line, applies to both the source file and
the man page, see man-pages(7).
####
Don't use '\c' after a normal line, it's use is to join the output of
_two_ macros without an intervening space.
###
-- System Information:
Debian Release: 12.0
APT prefers testing-security
APT policy: (500, 'testing-security'), (500, 'testing-proposed-updates'), (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.1.27-1 (SMP w/2 CPU threads; PREEMPT)
Kernel taint flags: TAINT_WARN
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages asciidoctor depends on:
ii ruby 1:3.1
ii ruby-asciidoctor 2.0.18-2
asciidoctor recommends no packages.
asciidoctor suggests no packages.
-- no debconf information
More information about the Pkg-ruby-extras-maintainers
mailing list