Locate api documentation from interface base classes

Bug #1132535 reported by Richard Wall
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
pydoctor
Fix Released
Undecided
Unassigned

Bug Description

In
 * https://twistedmatrix.com/documents/12.3.0/api/twisted.names.common.ResolverBase.html#getHostByName

getHostByName comes from IResolverSimple which is a base class of IResolver

Pydoctor only seems to include documentation from IResolver not the base class.

There is a way to enumerate the attributes of interface base classes described here...
 * http://stackoverflow.com/a/10825445/919436
 * http://apidoc.zope.org/++apidoc++/Interface/zope.interface.interfaces.IInterface/index.html

{{{
 names(all=False)

Get the interface attribute names

Return a sequence of the names of the attributes, including methods, included in the interface definition.

Normally, only directly defined attributes are included. If a true positional or keyword argument is given, then attributes defined by base classes will be included.

}}}

...which might be relevant.

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

The point here is that ResolverBase does not implement any interfaces, so there's no way that pydoctor can know where to get the interface docs from.

There is also a hilarious typo (missing @) at http://twistedmatrix.com/trac/browser/trunk/twisted/names/client.py#L34:

34 implementer(interfaces.IResolver)
35 class Resolver(common.ResolverBase):

which I guess I should report in Twisted trac, but I don't think this affects my point above.

Changed in pydoctor:
status: New → Fix Committed
Changed in pydoctor:
status: Fix Committed → Fix Released
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.