Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

methods inherited via more than one class are documented more than once #10

Closed
Tracked by #104
mwhudson opened this issue Jan 12, 2015 · 2 comments · Fixed by #579
Closed
Tracked by #104

methods inherited via more than one class are documented more than once #10

mwhudson opened this issue Jan 12, 2015 · 2 comments · Fixed by #579
Labels
Milestone

Comments

@mwhudson
Copy link
Contributor

See for example http://twistedmatrix.com/documents/9.0.0/api/twisted.internet.interfaces.IReadWriteDescriptor.html

I have this vague memory that there is code that's supposed to suppress the repeated documentation, but it clearly isn't working.


Imported from Launchpad using lp2gh.

@mwhudson mwhudson added Triaged This issue has been looked at by a core pydoctor dev it looks valid Medium priority labels Jan 12, 2015
@mthuurne
Copy link
Contributor

Assuming this is the problem, it still occurs with the latest pydoctor:

Inherited from IFileDescriptor (via IReadDescriptor):
...
Inherited from IFileDescriptor (via IWriteDescriptor):

So IFileDescriptor is listed as a superclass twice as a result of a diamond-shaped inheritance. However, ILoggingContext is listed only once, despite it being reachable via the same two routes:

Inherited from ILoggingContext (via IReadDescriptor, IFileDescriptor):

@tristanlatr
Copy link
Contributor

We should probably adapt our own version of the C3 algorithm that works with model.Class objects.

A nice implementation can be found at https://github.com/pilosus/c3linear

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants