public methods on private base classes should be more visible
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
pydoctor |
New
|
Undecided
|
Unassigned |
Bug Description
Especially if the changes I recommended in <https:/
For example, on <http://
Maybe the thing to do here is just to emphasize the "implements interfaces" section a bit more and display the whole interface docstring on each method rather than just the somewhat ambiguous "from" link.
Yeah, this is hard. I think I'd like to frame it a bit as "how do you direct people's attention to the methods that count" rather than anything to specifically to do with privacy.
It seems to me the dilemma is that when looking at a class that is derived from a base class, you might either want to understand the entire class as a thing -- in which case, just listing all methods in one big table makes sense -- or you might want to understand how this class differs from its base class -- in which case what pydoctor does now makes sense. Of course, if the base class is private, then presumably you're just inheriting for implementation only, and the former option makes sense.
FWIW, there is an option in pydoctor (inexplicably called --html- use-splitlinks) that generates both "one big table" and "per base class" tables and has some simple js to flip between them.
There is the also the issue of picking out interesting methods from a sea of detail. One thing we could do is highlight the methods that implement a method from an interface somehow?
I'll try to grab you on IRC to talk about this tomorrow.