Maarten ter Huurne
Maarten ter Huurne
Hi, I'm the current maintainer of pydoctor. When working on pydoctor's code, I came across a comment saying that `data-type` attributes are added to links to help `doc2dash`. While that...
Some top-level entries on the `classIndex.html` page aren't hyperlinked. There are several non-linked cases to deal with: - ~~classes that can be linked via intersphinx~~ - classes that are re-exported...
Currently the produced `objects.inv` file contains information on all documentables, whether they are private or public. I'm not sure whether that's desired though. For example a tool like `doc2dash` might...
`twisted.logger.extractField()` has return type `typing.Any`, but in the output this is not linked to the standard library documentation, despite the intersphinx inventory being available and other types being linked successfully....
Currently neither Twisted's customizations nor pydoctor supports Twisted's `deprecatedModuleAttribute` mechanism. There are about 40 uses of this mechanism in Twisted. Assuming that we implement #315, it would be pydoctor's job...
Currently neither Twisted's customizations nor pydoctor supports Twisted's `@deprecatedKeywordParameter`. Since currently there is no code marked with that decorator, that's not a problem right now, but there likely will be...
From `src/twisted/words/protocols/jabber/client.py`: (irrelevant parts cut out) ```py class BasicAuthenticator(xmlstream.ConnectAuthenticator): """ Authenticates an XmlStream against a Jabber server as a Client. @cvar INVALID_USER_EVENT: See L{IQAuthInitializer.INVALID_USER_EVENT}. @type INVALID_USER_EVENT: L{str} @cvar AUTH_FAILED_EVENT: See...
Intersphinx makes documentation much more useful, by being able to deep-link to other documentation. However, it is currently up to the maintainer to add the intersphinx URLs for all dependencies...
It would be a useful feature to have a spell check option for docstrings. Besides better readability, correct spelling also improves matches when doing a full-text search (another useful feature...
Currently we don't explicitly handle constructors in the output. Instead, we document methods like `__init__()` and `__new__()` and leave it up to the reader to figure out what the constructor...