pydoctor

Locate interface documentation via zope.interface.moduleProvides

Bug #1132527 reported by Richard Wall
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Twisted Buildbot Configuration
New
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

lp:~richardw/pydoctor/moduleprovides-1132527
Michael Hudson-Doyle: Approve
Diff: 113 lines (+57/-3)
2 files modified
pydoctor/test/test_zopeinterface.py (+17/-1)
pydoctor/zopeinterface.py (+40/-2)
Revision history for this message
Michael Hudson-Doyle (mwhudson) wrote :

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

Changed in pydoctor:
status: New → Triaged
Revision history for this message
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

Michael Hudson-Doyle (mwhudson)
Changed in pydoctor:
status: Triaged → Fix Committed
Michael Hudson-Doyle (mwhudson)
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.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.