unittest helpers(?) for verifying a package has valid docstrings

Bug #743185 reported by Jelmer Vernooij
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
pydoctor
Confirmed
Wishlist
Unassigned

Bug Description

It would be neat if there was some way of having the testsuite verify that the syntax of all docstrings, etc is valid - without generating all the output.

I might have a look at this myself, though hints as how to do this would be much appreciated.

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

Yes, this would be nice. I don't think it would be too hard either, I think you just need to iterate over system.allobjects and call epydoc2stan.doc2html on each object. The way errors are currently reported is a bit unhelpful for this, but that's probably easy to fix (you could just put reportErrors=reportErrors in doc2html's argument list for a good start I guess!).

Changed in pydoctor:
status: New → Confirmed
importance: Undecided → Wishlist
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.