Opened 7 years ago

Closed 7 years ago

Last modified 7 years ago

#6329 enhancement closed invalid (invalid)

pydoctor does not generate twisted.names.common.ResolverBase.getHostByName api documentation because it is in an interface base class

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

Description

I think its a shortcoming of pydoctor. See:

"""

In

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...

 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.

"""

Change History (6)

comment:1 Changed 7 years ago by Tom Prince

Resolution: fixed
Status: newclosed

Pydoctor has been updated to handle this.

comment:2 Changed 7 years ago by Jean-Paul Calderone

Resolution: fixed
Status: closedreopened

pydoctor is a separate project with its own bug tracker. Bug reports and feature requests should be filed there, not here.

Also, the task of upgrading whatever deployments the Twisted project has of pydoctor to a version which includes this new feature should be tracked elsewhere as well.

This is an issue tracker for issues with Twisted itself, not tools Twisted depends on nor operations tasks related to the Twisted project.

comment:3 Changed 7 years ago by Jean-Paul Calderone

Resolution: invalid
Status: reopenedclosed

comment:4 in reply to:  2 Changed 7 years ago by Glyph

Replying to exarkun:

Also, the task of upgrading whatever deployments the Twisted project has of pydoctor to a version which includes this new feature should be tracked elsewhere as well.

This is an issue tracker for issues with Twisted itself, not tools Twisted depends on nor operations tasks related to the Twisted project.

In principle I agree, but does such a place for operational task tracking actually exist? The twisted-website bugtracker on Launchpad, perhaps? This suggests we ought to delete or disable the "website" component here, as well.

comment:5 Changed 7 years ago by Jean-Paul Calderone

In principle I agree, but does such a place for operational task tracking actually exist? The twisted-website bugtracker on Launchpad, perhaps? This suggests we ought to delete or disable the "website" component here, as well.

That sounds right to me.

comment:6 in reply to:  5 Changed 7 years ago by Glyph

Replying to exarkun:

In principle I agree, but does such a place for operational task tracking actually exist? The twisted-website bugtracker on Launchpad, perhaps? This suggests we ought to delete or disable the "website" component here, as well.

That sounds right to me.

Okay, well, let's get meta here then.

Note: See TracTickets for help on using tickets.