diff options
| author | Brendan Abolivier <babolivier@matrix.org> | 2023-02-28 14:16:33 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-28 14:16:33 +0000 |
| commit | 521026897c3278344f76d9a7f0555acb49a724fb (patch) | |
| tree | f6c9412a0505541d70027feca8e93659281ae749 /changelog.d/14026.doc | |
| parent | Admin API endpoint to delete a reported event (#15116) (diff) | |
| download | synapse-521026897c3278344f76d9a7f0555acb49a724fb.tar.xz | |
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>
Diffstat (limited to 'changelog.d/14026.doc')
| -rw-r--r-- | changelog.d/14026.doc | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/changelog.d/14026.doc b/changelog.d/14026.doc new file mode 100644 index 0000000000..28fc5568ea --- /dev/null +++ b/changelog.d/14026.doc @@ -0,0 +1 @@ +Document how to use caches in a module. |