Fixup comments

Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
This commit is contained in:
Erik Johnston 2019-10-10 13:17:19 +01:00 committed by GitHub
parent 59e0ed8306
commit fe1c1e6c28
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -114,7 +114,7 @@ def _check_yield_points(f: Callable, changes: List[str]):
"""Wraps a generator that is about to be passed to defer.inlineCallbacks """Wraps a generator that is about to be passed to defer.inlineCallbacks
checking that after every yield the log contexts are correct. checking that after every yield the log contexts are correct.
Its perfectly valid for log contexts to change within a function, e.g. due It's perfectly valid for log contexts to change within a function, e.g. due
to new Measure blocks, so such changes are added to the given `changes` to new Measure blocks, so such changes are added to the given `changes`
list instead of triggering an exception. list instead of triggering an exception.
@ -150,7 +150,7 @@ def _check_yield_points(f: Callable, changes: List[str]):
# final yield and returning. E.g. we forgot to yield on a # final yield and returning. E.g. we forgot to yield on a
# function that returns a deferred. # function that returns a deferred.
# #
# We don't raise here as its perfectly valid for contexts to # We don't raise here as it's perfectly valid for contexts to
# change in a function, as long as it sets the correct context # change in a function, as long as it sets the correct context
# on resolving (which is checked separately). # on resolving (which is checked separately).
err = ( err = (
@ -171,7 +171,7 @@ def _check_yield_points(f: Callable, changes: List[str]):
if isinstance(d, defer.Deferred) and not d.called: if isinstance(d, defer.Deferred) and not d.called:
# This happens if we yield on a deferred that doesn't follow # This happens if we yield on a deferred that doesn't follow
# the log context rules without wrappin in a `make_deferred_yieldable`. # the log context rules without wrapping in a `make_deferred_yieldable`.
# We raise here as this should never happen. # We raise here as this should never happen.
if LoggingContext.current_context() is not LoggingContext.sentinel: if LoggingContext.current_context() is not LoggingContext.sentinel:
err = ( err = (