Skip to content

Commit

Permalink
Fix various typos in docs (#17114)
Browse files Browse the repository at this point in the history
### Pull Request Checklist

<!-- Please read
https://element-hq.github.io/synapse/latest/development/contributing_guide.html
before submitting your pull request -->

* [X] Pull request is based on the develop branch
* [X] Pull request includes a [changelog
file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog).
The entry should:
- Be a short description of your change which makes sense to users.
"Fixed a bug that prevented receiving messages from other servers."
instead of "Moved X method from `EventStore` to `EventWorkerStore`.".
  - Use markdown where necessary, mostly for `code blocks`.
  - End with either a period (.) or an exclamation mark (!).
  - Start with a capital letter.
- Feel free to credit yourself, by adding a sentence "Contributed by
@github_username." or "Contributed by [Your Name]." to the end of the
entry.
* [X] [Code
style](https://element-hq.github.io/synapse/latest/code_style.html) is
correct
(run the
[linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters))
  • Loading branch information
devonh authored Apr 26, 2024
1 parent 89fc579 commit 0fd6b26
Show file tree
Hide file tree
Showing 9 changed files with 13 additions and 12 deletions.
1 change: 1 addition & 0 deletions changelog.d/17114.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix various small typos throughout the docs.
2 changes: 1 addition & 1 deletion docs/admin_api/room_membership.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Edit Room Membership API

This API allows an administrator to join an user account with a given `user_id`
This API allows an administrator to join a user account with a given `user_id`
to a room with a given `room_id_or_alias`. You can only modify the membership of
local users. The server administrator must be in the room and have permission to
invite users.
Expand Down
6 changes: 3 additions & 3 deletions docs/message_retention_policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ clients.

## Server configuration

Support for this feature can be enabled and configured by adding a the
`retention` in the Synapse configuration file (see
Support for this feature can be enabled and configured by adding the
`retention` option in the Synapse configuration file (see
[configuration manual](usage/configuration/config_documentation.md#retention)).

To enable support for message retention policies, set the setting
Expand Down Expand Up @@ -117,7 +117,7 @@ In this example, we define three jobs:
policy's `max_lifetime` is greater than a week.

Note that this example is tailored to show different configurations and
features slightly more jobs than it's probably necessary (in practice, a
features slightly more jobs than is probably necessary (in practice, a
server admin would probably consider it better to replace the two last
jobs with one that runs once a day and handles rooms which
policy's `max_lifetime` is greater than 3 days).
Expand Down
2 changes: 1 addition & 1 deletion docs/postgres.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ can read more about that [here](https://www.postgresql.org/docs/10/kernel-resour
### Overview

The script `synapse_port_db` allows porting an existing synapse server
backed by SQLite to using PostgreSQL. This is done in as a two phase
backed by SQLite to using PostgreSQL. This is done as a two phase
process:

1. Copy the existing SQLite database to a separate location and run
Expand Down
4 changes: 2 additions & 2 deletions docs/setup/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,9 +259,9 @@ users, etc.) to the developers via the `--report-stats` argument.

This command will generate you a config file that you can then customise, but it will
also generate a set of keys for you. These keys will allow your homeserver to
identify itself to other homeserver, so don't lose or delete them. It would be
identify itself to other homeservers, so don't lose or delete them. It would be
wise to back them up somewhere safe. (If, for whatever reason, you do need to
change your homeserver's keys, you may find that other homeserver have the
change your homeserver's keys, you may find that other homeservers have the
old key cached. If you update the signing key, you should change the name of the
key in the `<server name>.signing.key` file (the second word) to something
different. See the [spec](https://matrix.org/docs/spec/server_server/latest.html#retrieving-server-keys) for more information on key management).
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/administration/admin_api/background_updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ For each update:

## Enabled

This API allow pausing background updates.
This API allows pausing background updates.

Background updates should *not* be paused for significant periods of time, as
this can affect the performance of Synapse.
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/administration/admin_faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ in memory constrained environments, or increased if performance starts to
degrade.

However, degraded performance due to a low cache factor, common on
machines with slow disks, often leads to explosions in memory use due
machines with slow disks, often leads to explosions in memory use due to
backlogged requests. In this case, reducing the cache factor will make
things worse. Instead, try increasing it drastically. 2.0 is a good
starting value.
Expand Down
4 changes: 2 additions & 2 deletions docs/user_directory.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,9 @@ The search term is then split into words:
* If unavailable, then runs of ASCII characters, numbers, underscores, and hyphens
are considered words.

The queries for PostgreSQL and SQLite are detailed below, by their overall goal
The queries for PostgreSQL and SQLite are detailed below, but their overall goal
is to find matching users, preferring users who are "real" (e.g. not bots,
not deactivated). It is assumed that real users will have an display name and
not deactivated). It is assumed that real users will have a display name and
avatar set.

### PostgreSQL
Expand Down
2 changes: 1 addition & 1 deletion docs/workers.md
Original file line number Diff line number Diff line change
Expand Up @@ -634,7 +634,7 @@ worker application type.

#### Push Notifications

You can designate generic worker to sending push notifications to
You can designate generic workers to send push notifications to
a [push gateway](https://spec.matrix.org/v1.5/push-gateway-api/) such as
[sygnal](https://github.com/matrix-org/sygnal) and email.

Expand Down

0 comments on commit 0fd6b26

Please sign in to comment.