diff options
author | Ingo Schwarze <schwarze@openbsd.org> | 2017-07-03 17:33:05 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@openbsd.org> | 2017-07-03 17:33:05 +0000 |
commit | 1de71bb307bce265869b412452d0d403674e5eda (patch) | |
tree | 6a6b5745dc3a8ba7800d2bba29704f143a0135e2 /mandoc.1 | |
parent | 7e3f3a2b83bdaf6b8929d44bacefb12730122d72 (diff) | |
download | mandoc-1de71bb307bce265869b412452d0d403674e5eda.tar.gz |
report trailing delimiters after macros where they are usually a mistake;
the idea came up in a discussion with Thomas Klausner <wiz at NetBSD>
Diffstat (limited to 'mandoc.1')
-rw-r--r-- | mandoc.1 | 12 |
1 files changed, 8 insertions, 4 deletions
@@ -905,11 +905,15 @@ list contains two consecutive entries describing the same .Ic \&Er number. -.It Sy "description line ends with a full stop" +.It Sy "trailing delimiter" .Pq mdoc -Do not use punctuation at the end of an -.Ic \&Nd -block. +The last argument of an +.Ic \&Ex , \&Fo , \&Nd , \&Nm , \&Os , \&Sh , \&Ss , \&St , +or +.Ic \&Sx +macro ends with a trailing delimiter. +This is usually bad style and often indicates typos. +Most likely, the delimiter can be removed. .It Sy "no blank before trailing delimiter" .Pq mdoc The last argument of a macro that supports trailing delimiter |