diff options
author | Erik Johnston <erik@matrix.org> | 2017-04-04 09:46:16 +0100 |
---|---|---|
committer | Erik Johnston <erik@matrix.org> | 2017-04-04 09:46:16 +0100 |
commit | 62b89daac6f4418d831d531fa40ad71aa0c74fb9 (patch) | |
tree | a5fa797ac7e65f85cae52cccd88451e5672257c6 /docs/log_contexts.rst | |
parent | Always advance stream tokens (diff) | |
parent | Merge pull request #2095 from matrix-org/rav/cull_log_preserves (diff) | |
download | synapse-62b89daac6f4418d831d531fa40ad71aa0c74fb9.tar.xz |
Merge branch 'develop' of github.com:matrix-org/synapse into erikj/repl_tcp_server
Diffstat (limited to 'docs/log_contexts.rst')
-rw-r--r-- | docs/log_contexts.rst | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/log_contexts.rst b/docs/log_contexts.rst index 8d04a973de..eb1784e700 100644 --- a/docs/log_contexts.rst +++ b/docs/log_contexts.rst @@ -204,9 +204,14 @@ That doesn't follow the rules, but we can fix it by wrapping it with This technique works equally for external functions which return deferreds, or deferreds we have made ourselves. -XXX: think this is what ``preserve_context_over_deferred`` is supposed to do, -though it is broken, in that it only restores the logcontext for the duration -of the callbacks, which doesn't comply with the logcontext rules. +You can also use ``logcontext.make_deferred_yieldable``, which just does the +boilerplate for you, so the above could be written: + +.. code:: python + + def sleep(seconds): + return logcontext.make_deferred_yieldable(get_sleep_deferred(seconds)) + Fire-and-forget --------------- |