There are a bunch of pydoctor errors in twisted.web.iweb

[exarkun]

twisted.web.iweb.IBodyProducer:372 invalid ref to IConsumer
twisted.web.iweb.IRequest.getHost:107 invalid ref to IAddress
twisted.web.iweb.IRequest.getClientIP:115 invalid ref to NoneType
twisted.web.iweb.IRequest.getClient:125 invalid ref to NoneType
twisted.web.iweb.IRequest.setLastModified:266 invalid ref to NOT_MODIFIED
twisted.web.iweb.IRequest.setLastModified:266 invalid ref to CACHED
twisted.web.iweb.IRequest.setETag:288 invalid ref to NOT_MODIFIED
twisted.web.iweb.IRequest.setETag:288 invalid ref to PRECONDITION_FAILED
twisted.web.iweb.IRequest.setETag:288 invalid ref to CACHED
twisted.web.iweb.ICredentialFactory:326 invalid ref to ICredentials
twisted.web.iweb.IBodyProducer:372 invalid ref to IConsumer
twisted.web.iweb.IBodyProducer:372 invalid ref to IConsumer
twisted.web.iweb.IBodyProducer:372 invalid ref to IConsumer.unregisterProducer
twisted.web.iweb.IBodyProducer:372 invalid ref to Deferred
twisted.web.iweb.IBodyProducer:372 invalid ref to IConsumer.write
twisted.web.iweb.IBodyProducer.length:399 invalid ref to UNKNOWN_LENGTH
twisted.web.iweb.IBodyProducer.startProducing:406 invalid ref to IConsumer
twisted.web.iweb.IBodyProducer.stopProducing:416 invalid ref to IProducer.stopProducing
twisted.web.iweb.IBodyProducer.stopProducing:416 invalid ref to Deferred
twisted.web.iweb.IBodyProducer.length:399 invalid ref to UNKNOWN_LENGTH
twisted.web.iweb.IBodyProducer.startProducing:406 invalid ref to IConsumer
twisted.web.iweb.IBodyProducer.startProducing:406 invalid ref to Deferred
twisted.web.iweb.IBodyProducer.startProducing:406 invalid ref to Failure
twisted.web.iweb.IBodyProducer.stopProducing:416 invalid ref to IProducer.stopProducing
twisted.web.iweb.IBodyProducer.stopProducing:416 invalid ref to Deferred
twisted.web.iweb.IRenderable.render:445 invalid ref to NoneType
twisted.web.iweb.IResponse.length:497 invalid ref to UNKNOWN_LENGTH
twisted.web.iweb.IResponse.deliverBody:505 invalid ref to IProtocol
twisted.web.iweb.IResponse.length:497 invalid ref to UNKNOWN_LENGTH
twisted.web.iweb.IResponse.deliverBody:505 invalid ref to IProtocol

Many of these are duplicated, but that's how pydoctor rolls. Some of them also cannot be fixed presently, due to  links to module attributes not being supported.

[exarkun]

(In [36463]) Branching to 'iweb-api-errors-6196'

[mwh]

Using r588 of pydoctor trunk, the invalid refs remaining in iweb are:

twisted.web.iweb.IRequest.setLastModified:261 invalid ref to http.NOT_MODIFIED twisted.web.iweb.IRequest.setLastModified:261 invalid ref to http.CACHED twisted.web.iweb.IRequest.setETag:283 invalid ref to http.NOT_MODIFIED twisted.web.iweb.IRequest.setETag:283 invalid ref to http.CACHED

These seem to be problems with http's docstring: it says @var cached: not @var CACHED: and NOT_MODIFIED is not documented at all. I think this should be fixed before the branch is merged.

[exarkun]

(In [36467]) Spell CACHED correctly and also document NOT_MODIFIED.

refs #6196

[exarkun]

Thanks. Some more errors fixed.

[mwh]

This looks good to merge now.

[exarkun]

(In [36471]) Merge iweb-api-errors-6196

Author: exarkun Reviewer: mwhudson Fixes: #6196

Fix a few API documentation issues in twisted.web.iweb and twisted.web.http.