Code review comment for lp:~fwereade/pyjuju/fix-docstrings

Revision history for this message
Jim Baker (jimbaker) wrote :

+1, overall this looks very good. It would seem possible to cross-reference imported names without being explicit as to their path (eg :class:`ProviderMachine` instead of :class:`ensemble.machine.ProviderMachine`) as long as that was unambiguous, but a quick experiment shows that Sphinx as configured right now won't do that.

Minor nits: when using singlehtml, links to source do not work. Also, the headings in that view really don't work well with the size of the left column. Maybe in general we would want to collapse the headings to the second level of the package namespace, under ensemble, that is just ensemble.agents instead of also seeing ensemble.agents.base, ensemble.agents.dummy, etc.

review: Approve

« Back to merge proposal