Fix docstring cross-references

[twisted-trac]

	@mthuurne reported
Trac ID	trac#9873
Type	defect
Created	2020-06-23 09:09:16Z

I made pydoctor complain if an L{identifier} cross-reference cannot be resolved. This is the result when run on Twisted trunk:

src/twisted/cred/credentials.py:31: invalid ref to 'zope.interface.declarations.implementer' not resolved
src/twisted/internet/defer.py:1534: invalid ref to 'inlineCallback' not resolved
src/twisted/logger/_json.py:182: invalid ref to 'dumps' not resolved
src/twisted/logger/_json.py:182: invalid ref to 'dumps' not resolved
src/twisted/names/authority.py:61: invalid ref to 'byte' not resolved
src/twisted/web/_element.py:30: invalid ref to 'zope.interface.declarations.implementer' not resolved
src/twisted/web/_auth/wrapper.py:189: invalid ref to 'ResourceWrapper' not resolved
src/twisted/web/_auth/wrapper.py:189: invalid ref to 'ResourceWrapper' not resolved
src/twisted/words/xish/domish.py:264: invalid ref to 'stre' not resolved
src/twisted/words/xish/domish.py:524: invalid ref to 'stre' not resolved

• byte, stre and inlineCallback are typos
• dumps is json.dumps, but pydoctor fails to resolve this
• ResourceWrapper is an inner class cross-referencing itself
• zope.interface.declarations.implementer is documented only under its shorter name zope.interface.implementer

I'll create a PR to solve at least some of these.

Searchable metadata

trac-id__9873 9873
type__defect defect
reporter__mthuurne mthuurne
priority__normal normal
milestone__None None
branch__ 
branch_author__ 
status__closed closed
resolution__fixed fixed
component__core core
keywords__review review
time__1592903356008865 1592903356008865
changetime__1592975910721211 1592975910721211
version__None None
owner__mthuurne mthuurne

[twisted-trac]

	@mthuurne commented

PR is here: #1318

I didn't address dumps and ResourceWrapper, since those references are in inner functions that will no longer be processed once pydoctor PR 196 gets merged.

[twisted-trac]

	@rodrigc set owner to @mthuurne

Approved here: #1318 (review)

[twisted-trac]

	@mthuurne set status to closed

In changeset fd50e9e

#!CommitTicketReference repository="" revision="fd50e9e29003f7e3ed789190d27e125954d19ef3"
Merge pull request #1318 from twisted/9873-mthuurne-docstringxref

Fix docstring cross-references

Author: mthuurne
Reviewer: rodrigc
Fixes: ticket:9873