[Doc-SIG] Problems in pytest.1

esr at thyrsus.com esr at thyrsus.com
Tue Jun 12 15:16:14 EDT 2018

This is automatically generated email about markup problems in a man
page for which you appear to be responsible.  If you are not the right
person or list, please tell me so I can correct my database.

See http://catb.org/~esr/doclifter/bugs.html for details on how and
why these patches were generated.  Feel free to email me with any
questions.  Note: These patches do not change the modification date of
any manual page.  You may wish to do that by hand.

I apologize if this message seems spammy or impersonal. The volume of
markup bugs I am tracking is over five hundred - there is no real
alternative to generating bugmail from a database and template.

                             Eric S. Raymond
-------------- next part --------------
Problems with pytest.1:

Broken command synopsis syntax.  This may mean you're using a
construction in the command synopsis other than the standard
[ ] | { }, or it may mean you have running text in the command synopsis
section (the latter is not technically an error, but most cases of it
are impossible to translate into DocBook markup), or it may mean the
command syntax fails to match the description.

Running text cannot occur in Synopsis sections; this make lifting to XML 
impossible.  This page was rather ill-formed, I have re-sectioned it.

--- pytest.1-unpatched	2010-07-23 03:28:44.000000000 -0400
+++ pytest.1	2010-07-23 03:30:00.000000000 -0400
@@ -5,8 +5,7 @@
 usage: pytest [OPTIONS] [testfile [testpattern]]
 pytest path/to/mytests.py
 pytest path/to/mytests.py TheseTests
@@ -18,7 +17,7 @@
 pytest \fB\-\-coverage\fR test_foo.py
 (only if logilab.devtools is available)
-.SS "options:"
 \fB\-h\fR, \fB\-\-help\fR
 show this help message and exit

More information about the Doc-SIG mailing list