aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/mandoc.1
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2017-07-03 17:33:05 +0000
committerIngo Schwarze <schwarze@openbsd.org>2017-07-03 17:33:05 +0000
commit90ba5141e31f73760148000ed0d98d9b7c612a63 (patch)
tree3c04d358dea3f9040a5b174bde0b950816e89e2d /mandoc.1
parentdcf99dab6ac9d82bc6581c4ea0ea85bc4a98736e (diff)
downloadmandoc-90ba5141e31f73760148000ed0d98d9b7c612a63.tar.gz
mandoc-90ba5141e31f73760148000ed0d98d9b7c612a63.tar.zst
mandoc-90ba5141e31f73760148000ed0d98d9b7c612a63.zip
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.114
1 files changed, 9 insertions, 5 deletions
diff --git a/mandoc.1 b/mandoc.1
index 09c68895..d906befb 100644
--- a/mandoc.1
+++ b/mandoc.1
@@ -1,4 +1,4 @@
-.\" $Id: mandoc.1,v 1.212 2017/07/03 13:40:18 schwarze Exp $
+.\" $Id: mandoc.1,v 1.213 2017/07/03 17:33:05 schwarze Exp $
.\"
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\" Copyright (c) 2012, 2014-2017 Ingo Schwarze <schwarze@openbsd.org>
@@ -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