twisted.cred should have better API docs

[twisted-trac]

	@twm reported
Trac ID	trac#9724
Type	enhancement
Created	2019-11-07 05:22:16Z

The API docs for classes in the twisted.cred.checkers module have some issues:

• Many undocumented methods
• Undocumented parameters
• Missing types
• Missing cross-references
• Incorrect epytext syntax (e.g., _must_)

Make it better!

Searchable metadata

trac-id__9724 9724
type__enhancement enhancement
reporter__twm twm
priority__normal normal
milestone__None None
branch__ 
branch_author__ 
status__closed closed
resolution__fixed fixed
component__core core
keywords__None None
time__1573104136030817 1573104136030817
changetime__1573285739745676 1573285739745676
version__None None
owner__glyph glyph

[twisted-trac]

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

[twisted-trac]

	@twm removed owner @twm set status to new

#1194

[twisted-trac]

	@glyph set owner to @glyph

#1194 (review)

I'll merge it.

[twisted-trac]

	@glyph set status to closed

In changeset 9c88278

#!CommitTicketReference repository="" revision="9c8827835f1fb81abb4622b3da2e59bd6a4e08bd"
Merge pull request #1194 from twisted/cred-docs-9724

Author: twm

Reviewer: glyph

Fixes: ticket:9724

The documentation of the twisted.cred.checkers module has been extended and corrected.