t.w.c.ContentDecoderAgent docstring improvements

[twisted-trac]

	@twm reported
Trac ID	trac#9742
Type	enhancement
Created	2019-12-08 06:28:32Z
Branch	https://github.com/twisted/twisted/tree/9742-contentdecoderagent-docs

twisted.web.client.ContentDecoderAgent's docstring doesn't document the type of the decoders parameter, and the example it gives --- (('gzip', GzipDecoder)) --- is actively misleading (should be b'gzip', wrong tuple syntax).

This verbiage is also unclear:

The name declares which decoding the decoder supports, and the decoder must return a response object when called/instantiated.

It should clarify that the decoder takes an IResponse and returns an IResponse.

The docstring should also be less ambiguous about where GzipDecoder lives.

Searchable metadata

trac-id__9742 9742
type__enhancement enhancement
reporter__twm twm
priority__normal normal
milestone__None None
branch__9742_contentdecoderagent_docs 9742-contentdecoderagent-docs
branch_author__ 
status__closed closed
resolution__fixed fixed
component__web web
keywords__None None
time__1575786512396559 1575786512396559
changetime__1585371509379060 1585371509379060
version__None None
owner__twm twm

[twisted-trac]

	@twm set owner to @twm @twm set status to assigned

[twisted-trac]

	@twm removed owner @twm set status to new

Ready for review: #1205

[twisted-trac]

	@rodrigc set owner to @twm

Approved: #1205 (review)

[twisted-trac]

	@twm set status to closed

In changeset 40c5235

#!CommitTicketReference repository="" revision="40c523529ca235c13e0354d8b9bc934154dc323a"
Merge pull request #1205 from twisted/9742-contentdecoderagent-docs

Author: twm
Reviewer: rodrigc
Fixes: ticket:9742

Improve ContentDecoderAgent docs