Coder Social home page Coder Social logo

Comments (3)

mwhudson avatar mwhudson commented on September 23, 2024

(by glyph)
Just bumped into this again. I think it's quite confusing for users to be tossed into private parts of the hierarchy in order to see what interfaces are available.

from pydoctor.

glyph avatar glyph commented on September 23, 2024

@mwhudson @hawkowl FYI: in a couple of recent interactions with users I have noticed that this is definitely the source of a lot of confusion.

from pydoctor.

mthuurne avatar mthuurne commented on September 23, 2024

What would the desired output look like?

Should the documentation page for a class just list all (directly or via inheritance) implemented interfaces in a simple list? For example:

Implements interfaces: IBoxSender, IProtocol, IResponderLocator, IBoxReceiver.

Or should methods be grouped by which interface defines them? And if so, should they be moved there from the implementation class, possibly dropping some implementation classes from the class page altogether if they have 0 methods left after the moves?

For example, the current documentation reads:

Inherited from _DescriptorExchanger (via BinaryBoxProtocol):
Method fileDescriptorReceived: Collect received file descriptors to be claimed later by Descriptor.

But it could be presented like this instead:

From IFileDescriptorReceiver:
Method fileDescriptorReceived: Called when a file descriptor is received over the connection.

As shown here, the implementation docstring is not the same as the interface docstring, so which should be shown?

Also, should there be a mention of where the implementation resides? I imagine that for people using Twisted that doesn't matter much, but for developers or people tracking down a bug it can be useful to have a source link to the implementation.

from pydoctor.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.