Opened 7 years ago

Last modified 7 years ago

#6328 enhancement new

— at twisted.names.client lookup functions duplicate or reference the documntation of `IResolver`Version 3

Reported by: Richard Wall Owned by: Tom Prince
Priority: normal Milestone:
Component: names Keywords: documentation
Cc: Branch:
Author:

Description (last modified by Tom Prince)

In order to document the free functions in twistd.names.client implement most of the interface of IResolver, so the documentation should match them. #4685 handles this by just having @see` annotations. It would be better if we could include the documentation automatically.

See:

"""

In #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:

"""

Change History (3)

comment:1 Changed 7 years ago by Tom Prince

Keywords: documentation added

comment:2 Changed 7 years ago by Tom Prince

Owner: set to Tom Prince

comment:3 Changed 7 years ago by Tom Prince

Description: modified (diff)
Summary: twisted.names.client lookup functions api documentation should be inserted via zope.interface.moduleProvidestwisted.names.client lookup functions duplicate or reference the documntation of `IResolver`
Note: See TracTickets for help on using tickets.