Skip to content

Commit b5a28fb

Browse files
committed
Tweaks on the python module readme
1 parent 370ae9f commit b5a28fb

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

synapse/README.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ Usage
3333
Configuration options
3434
---------------------
3535

36-
Apart from the `prefix` the following config options are available:
36+
Apart from the ``prefix`` the following config options are available:
3737

38-
- `ttl`: The time-to-live of the rendezvous session. Defaults to 60s.
39-
- `max_bytes`: The maximum number of bytes that can be sent in a single request. Defaults to 4096 bytes.
40-
- `max_entries`: The maximum number of entries to keep. Defaults to 10 000.
38+
- ``ttl``: The time-to-live of the rendezvous session. Defaults to 60s.
39+
- ``max_bytes``: The maximum number of bytes that can be sent in a single request. Defaults to 4096 bytes.
40+
- ``max_entries``: The maximum number of entries to keep. Defaults to 10 000.
4141

4242
An example configuration setting these and a custom prefix would like::
4343

@@ -56,5 +56,5 @@ An example configuration setting these and a custom prefix would like::
5656
Memory usage
5757
^^^^^^^^^^^^
5858

59-
`max_entries` and `max_bytes` allow to tune how much memory the module may take.
60-
There is a constant overhead of approximately 1KiB per entry, so with the default config (`max_bytes = 4KiB, max_entries = 10000`), the maximum theorical memory footprint of the module is `(4KiB + 1KiB) * 10000 = 50MiB`.
59+
``max_entries`` and ``max_bytes`` allow to tune how much memory the module may take.
60+
There is a constant overhead of approximately 1KiB per entry, so with the default config (``max_bytes = 4KiB``, ``max_entries = 10000``), the maximum theorical memory footprint of the module is ``(4KiB + ~1KiB) * 10000 ~= 50MiB``.

0 commit comments

Comments
 (0)