diff options
| author | Erik Johnston <erik@matrix.org> | 2023-12-13 16:37:10 +0000 |
|---|---|---|
| committer | Erik Johnston <erik@matrix.org> | 2023-12-13 16:37:10 +0000 |
| commit | 930dc9e2d3efd6d82b86c2205b80d6ccb9b4bb86 (patch) | |
| tree | 47c9a74f21df24a92c30876b15306c1f7034f2f8 /docs/development | |
| parent | Update book location (diff) | |
| download | synapse-930dc9e2d3efd6d82b86c2205b80d6ccb9b4bb86.tar.xz | |
Fix typo
Diffstat (limited to 'docs/development')
| -rw-r--r-- | docs/development/git.md | 10 | ||||
| -rw-r--r-- | docs/development/synapse_architecture/streams.md | 6 |
2 files changed, 8 insertions, 8 deletions
diff --git a/docs/development/git.md b/docs/development/git.md index 3d8f9fc4fc..b68c03fec1 100644 --- a/docs/development/git.md +++ b/docs/development/git.md @@ -14,11 +14,11 @@ b2dba0607`: Note how the commit comment explains clearly what is changing and why. Also note the *absence* of merge commits, as well as the absence of commits called things like (to pick a few culprits): -[“pep8”](https://github.com/element.-hq/synapse/commit/84691da6c), [“fix broken -test”](https://github.com/element.-hq/synapse/commit/474810d9d), -[“oops”](https://github.com/element.-hq/synapse/commit/c9d72e457), -[“typo”](https://github.com/element.-hq/synapse/commit/836358823), or [“Who's -the president?”](https://github.com/element.-hq/synapse/commit/707374d5d). +[“pep8”](https://github.com/element-hq/synapse/commit/84691da6c), [“fix broken +test”](https://github.com/element-hq/synapse/commit/474810d9d), +[“oops”](https://github.com/element-hq/synapse/commit/c9d72e457), +[“typo”](https://github.com/element-hq/synapse/commit/836358823), or [“Who's +the president?”](https://github.com/element-hq/synapse/commit/707374d5d). There are a number of reasons why keeping a clean commit history is a good thing: diff --git a/docs/development/synapse_architecture/streams.md b/docs/development/synapse_architecture/streams.md index 0c6e2f8811..4981416835 100644 --- a/docs/development/synapse_architecture/streams.md +++ b/docs/development/synapse_architecture/streams.md @@ -1,7 +1,7 @@ ## Streams Synapse has a concept of "streams", which are roughly described in [`id_generators.py`]( - https://github.com/element.-hq/synapse/blob/develop/synapse/storage/util/id_generators.py + https://github.com/element-hq/synapse/blob/develop/synapse/storage/util/id_generators.py ). Generally speaking, streams are a series of notifications that something in Synapse's database has changed that the application might need to respond to. For example: @@ -11,12 +11,12 @@ For example: - The to-device stream reports when a device has a new [to-device message](https://spec.matrix.org/v1.7/client-server-api/#send-to-device-messaging). See [`synapse.replication.tcp.streams`]( - https://github.com/element.-hq/synapse/blob/develop/synapse/replication/tcp/streams/__init__.py + https://github.com/element-hq/synapse/blob/develop/synapse/replication/tcp/streams/__init__.py ) for the full list of streams. It is very helpful to understand the streams mechanism when working on any part of Synapse that needs to respond to changes—especially if those changes are made by different workers. To that end, let's describe streams formally, paraphrasing from the docstring of [`AbstractStreamIdGenerator`]( - https://github.com/element.-hq/synapse/blob/a719b703d9bd0dade2565ddcad0e2f3a7a9d4c37/synapse/storage/util/id_generators.py#L96 + https://github.com/element-hq/synapse/blob/a719b703d9bd0dade2565ddcad0e2f3a7a9d4c37/synapse/storage/util/id_generators.py#L96 ). ### Definition |