runWithWarningsSuppressed docstring should mention it special-cases deferreds

[twisted-trac]

	@twm reported
Trac ID	trac#10238
Type	enhancement
Created	2021-07-25 19:06:16Z
Branch	https://github.com/twisted/twisted/tree/10238-runwithwarnings-docs

The twisted.internet.utils.runWithWarningsSuppressed function waits to restore the warning filter until after a deferred returned by f fires, but the docstring doesn't mention this. It's kinda important so it should be mentioned.

Searchable metadata

trac-id__10238 10238
type__enhancement enhancement
reporter__twm twm
priority__normal normal
milestone__None None
branch__10238_runwithwarnings_docs 10238-runwithwarnings-docs
branch_author__ 
status__closed closed
resolution__fixed fixed
component__core core
keywords__review review
time__1627239976817469 1627239976817469
changetime__1628372110590517 1628372110590517
version__None None
owner__Tom_Most__twm_____ Tom Most <twm@...>

[twisted-trac]

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

[twisted-trac]

	@twm removed owner @twm set status to new

PR: #1640

[twisted-trac]

	@twm set owner to @twm @twm set status to closed

In changeset c0429b9

#!CommitTicketReference repository="" revision="c0429b986082de9937b3ccd69a6c9af1cb2519ff"
Merge pull request #1640 from twisted/10238-runwithwarnings-docs

Author: twm
Reviewer: adiroiban
Fixes: ticket:10238

Document runWithWarningsSuppressed deferred behavior