Code review comment for lp:~termie/nova/more_docstring

> I am all for more docstrings, but they can be overkill. I think we should
> only require docstrings on public methods, and not in tests. In addition,
> does anyone know how to do docstring inheritance? if I'm implementing a
> method defined and well documented by a base class, I want to point at those
> docs.

It looks like sphinx supports some cross-referencing: http://sphinx.pocoo.org/domains.html#python-roles

It isn't quite inheritance but at least gets people to the right place if you think they will have a hard time.

> On Mar 28, 2011 11:50 AM, "termie" <email address hidden> wrote:
> >> I would be rather all reviewers call people out on *having* docstrings
> for all
> >> methods rather than calling them out for an extra newline. I'd say
> disallowing
> >> a newline is borderline asinine in that it's not going to be enforceable.
> >
> > It is easy to enforce, justinsb already has a branch out that does the
> checking :)
> > --
> > https://code.launchpad.net/~termie/nova/more_docstring/+merge/55198
> > You are requested to review the proposed merge of
> lp:~termie/nova/more_docstring into lp:nova.