Skip to content
Snippets Groups Projects
Commit a4cb2165 authored by Richard van der Hoff's avatar Richard van der Hoff Committed by Richard van der Hoff
Browse files

log_contexts.rst: fix formatting of Note block

Apparently the github RST renderer doesn't like Note blocks.
parent d78d0898
No related branches found
No related tags found
No related merge requests found
...@@ -94,13 +94,13 @@ To circumvent this problem, synapse code assumes that, wherever you have a ...@@ -94,13 +94,13 @@ To circumvent this problem, synapse code assumes that, wherever you have a
deferred, you will want to yield on it. To that end, whereever functions return deferred, you will want to yield on it. To that end, whereever functions return
a deferred, we adopt the following conventions: a deferred, we adopt the following conventions:
.. note:: Rules for functions returning deferreds: **Rules for functions returning deferreds:**
* If the deferred is already complete, the function returns with the same * If the deferred is already complete, the function returns with the same
logcontext it started with. logcontext it started with.
* If the deferred is incomplete, the function clears the logcontext before * If the deferred is incomplete, the function clears the logcontext before
returning; when the deferred completes, it restores the logcontext before returning; when the deferred completes, it restores the logcontext before
running any callbacks. running any callbacks.
That sounds complicated, but actually it means a lot of code (including the That sounds complicated, but actually it means a lot of code (including the
example above) "just works". There are two cases: example above) "just works". There are two cases:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment