not all epytext errors detected by documentation builder

Bug #1027879 reported by Jean-Paul Calderone
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Twisted Buildbot Configuration
New
Undecided
Unassigned
pydoctor
New
Undecided
Unassigned

Bug Description

pydoctor has two formats it uses to report epytext problems. One, we catch, "name: error text". Another we don't:

    these 3 objects' docstrings are not proper epytext:
        twisted.mail.imap4.getBodyStructure
        twisted.mail.imap4._SinglepartMessageStructure._extended
        twisted.mail.imap4._MultipartMessageStructure._extended

The result is that errors of this type don't turn the documentation builder red, which is bad.

Revision history for this message
Tom Prince (tom.prince) wrote :

This is tricky to handle, since pydoctor doesn't appear to have a consistent error format.

I think the sane solution to this to get pydoctor to output errors in a standard format, and then
we don't need to figure out what all to expect.

Michael: I'd be happy to do this, if it would be acceptable.

Revision history for this message
Michael Hudson-Doyle (mwhudson) wrote :

i'm fairly sure that the errors reported at the end are a summary of errors reported during the run. if that's not the case, then that's a bug.

i'm also totally open to making pydoctor's error reporting more consistent...

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.