comments in doctests offset pocketlint's line numbers

[Edwin Grubbs]

I just upgraded to pocketlint 0.5.4-0ppa0, and I noticed that line 182 of lp/registry/docs/vocabularies.txt is several lines above the moin header that actually causes the error. I was able to recreate the problem with this smaller sample using comments in the doctest.

--------------------------------------------------------------------------------------------
Mailing lists are not active when they are first registered.

    >>> # These are the convoluted steps to create some mailing lists. We
    >>> # can't use the shortcuts that other related tests use because those
    >>> # leave the list in the ACTIVE state and we want to check things
    >>> # before they get to that state.

=== DistroSeriesVocabulary ===

Reflects the available distribution series. Results are ordered by
`name`

[Curtis Hovey (sinzui)]

DocTestParser drops comments in examples. It expects source code an want sections. I suppose the design assumes that comments belong in the narrative, not in example code users are expected to copy.

[Curtis Hovey (sinzui)]

Since comments in doctest examples are bad form, the real issue here is that pocketlint does not report that the comment should be removed.