synapse/docs/modules
Brendan Abolivier 521026897c
Add documentation for caching in a module (#14026)
* Add documentation for caching in a module

* Changelog

* Formatting

* Wrap lines at a length that mdbook is happier with

* Typo fix

Co-authored-by: Erik Johnston <erik@matrix.org>

* Link to recent version of the API

In the longer term I'd like to see us generate markdown with Sphinx.

* Refer to public `cached` decorator

* Mark caching as being added in 1.74

Some of the underlying infrastructure was added in 1.69, but the
public-facing `cached` decorator was only added in 1.74. It is the
latter that I think we should be advertising.

* Update docs/modules/writing_a_module.md

Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>

---------

Co-authored-by: David Robertson <davidr@element.io>
Co-authored-by: Erik Johnston <erik@matrix.org>
Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
2023-02-28 14:16:33 +00:00
..
account_data_callbacks.md Add a module callback to react to account data changes (#12327) 2022-04-01 11:22:48 +02:00
account_validity_callbacks.md Document the version of Synapse each module callback was introduced in (#11132) 2021-10-20 11:04:27 +00:00
background_update_controller_callbacks.md Make background updates controllable via a plugin (#11306) 2021-11-29 17:57:06 +01:00
index.md Document Synapse's behaviour when dealing with multiple modules (#11096) 2021-10-18 18:26:52 +02:00
password_auth_provider_callbacks.md Fix return value in example on password_auth_provider_callbacks.md (#13450) 2022-08-04 13:03:36 +01:00
porting_legacy_module.md Port the Password Auth Providers module interface to the new generic interface (#10548) 2021-10-13 11:21:52 +00:00
presence_router_callbacks.md Document the version of Synapse each module callback was introduced in (#11132) 2021-10-20 11:04:27 +00:00
spam_checker_callbacks.md Fix version number in spam checker callbacks doc (#13047) 2022-06-14 17:24:25 +02:00
third_party_rules_callbacks.md Add module API callbacks for adding and deleting local 3PID associations (#15044 2023-02-27 14:19:19 +00:00
writing_a_module.md Add documentation for caching in a module (#14026) 2023-02-28 14:16:33 +00:00