diff options
| author | Richard van der Hoff <github@rvanderhoff.org.uk> | 2017-03-20 11:59:49 +0000 |
|---|---|---|
| committer | Richard van der Hoff <richard@matrix.org> | 2017-03-20 12:01:26 +0000 |
| commit | a4cb21659b0c00c3d04a8a956f413b8cd7a4a238 (patch) | |
| tree | 60c1f63c9105134e77588b03a9d85e9089ac5ea5 /docs | |
| parent | log_contexts.rst: fix typos (diff) | |
| download | synapse-a4cb21659b0c00c3d04a8a956f413b8cd7a4a238.tar.xz | |
log_contexts.rst: fix formatting of Note block
Apparently the github RST renderer doesn't like Note blocks.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/log_contexts.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/log_contexts.rst b/docs/log_contexts.rst index ffe438c614..8d04a973de 100644 --- a/docs/log_contexts.rst +++ b/docs/log_contexts.rst @@ -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 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 - logcontext it started with. - * If the deferred is incomplete, the function clears the logcontext before - returning; when the deferred completes, it restores the logcontext before - running any callbacks. + * If the deferred is already complete, the function returns with the same + logcontext it started with. + * If the deferred is incomplete, the function clears the logcontext before + returning; when the deferred completes, it restores the logcontext before + running any callbacks. That sounds complicated, but actually it means a lot of code (including the example above) "just works". There are two cases: |