Locate interface documentation via zope.interface.moduleProvides

Bug #1132527 reported by Richard Wall on 2013-02-24
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Twisted Buildbot Configuration
Undecided
Unassigned
pydoctor
Fix Released
Undecided
Unassigned

Bug Description

In https://twistedmatrix.com/trac/ticket/4685?replyto=16#comment:12 we have a series of module global functions which provide the twisted.internet.interfaces.IResolver interface.

We currently insert @see: L{twisted.internet.interfaces.IResolver.lookupAddress} so that we see links to the interface docs in the pydoctor api docs.

It would be nicer if pydoctor could find and insert the interface documentation - just like it does when it encounters an @implementer decorator.

See:
 * https://twistedmatrix.com/trac/changeset/37229/branches/IResolver-docs-4685

Related branches

Michael Hudson-Doyle (mwhudson) wrote :

Makes sense. Not sure when I'm likely to get to it tbh.

Changed in pydoctor:
status: New → Triaged
Richard Wall (richardw) wrote :

I've submitted a branch for code review.

Also linked this ticket to https://bugs.launchpad.net/twisted-buildbot-configuration as a reminder to upgrade the Twisted buildbot when this issue is fixed.

As discussed in https://bugs.launchpad.net/twisted-website/+bug/1140776

Changed in pydoctor:
status: Triaged → Fix Committed
Changed in pydoctor:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers