summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorRichard van der Hoff <github@rvanderhoff.org.uk>2018-03-12 16:19:13 +0000
committerGitHub <noreply@github.com>2018-03-12 16:19:13 +0000
commitb984dd0b739813594ce58c64550a4ee1a75b074b (patch)
treeb06549ae36633389d25b7f7fc9f8a6664cad5b18 /docs
parentMerge pull request #2965 from matrix-org/rav/request_logging (diff)
parentFactor run_in_background out from preserve_fn (diff)
downloadsynapse-b984dd0b739813594ce58c64550a4ee1a75b074b.tar.xz
Merge pull request #2961 from matrix-org/rav/run_in_background
Factor run_in_background out from preserve_fn
Diffstat (limited to 'docs')
-rw-r--r--docs/log_contexts.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/log_contexts.rst b/docs/log_contexts.rst
index b19b7fa1ea..82ac4f91e5 100644
--- a/docs/log_contexts.rst
+++ b/docs/log_contexts.rst
@@ -279,9 +279,9 @@ Obviously that option means that the operations done in
 that might be fixed by setting a different logcontext via a ``with
 LoggingContext(...)`` in ``background_operation``).
 
-The second option is to use ``logcontext.preserve_fn``, which wraps a function
-so that it doesn't reset the logcontext even when it returns an incomplete
-deferred, and adds a callback to the returned deferred to reset the
+The second option is to use ``logcontext.run_in_background``, which wraps a
+function so that it doesn't reset the logcontext even when it returns an
+incomplete deferred, and adds a callback to the returned deferred to reset the
 logcontext. In other words, it turns a function that follows the Synapse rules
 about logcontexts and Deferreds into one which behaves more like an external
 function — the opposite operation to that described in the previous section.
@@ -293,7 +293,7 @@ It can be used like this:
     def do_request_handling():
         yield foreground_operation()
 
-        logcontext.preserve_fn(background_operation)()
+        logcontext.run_in_background(background_operation)
 
         # this will now be logged against the request context
         logger.debug("Request handling complete")