diff --git a/changelogs/client_server/newsfragments/2318.clarification b/changelogs/client_server/newsfragments/2318.clarification new file mode 100644 index 00000000..f8108646 --- /dev/null +++ b/changelogs/client_server/newsfragments/2318.clarification @@ -0,0 +1 @@ +Fix various typos throughout the specification. Contributed by @HarHarLinks. diff --git a/changelogs/internal/newsfragments/2318.clarification b/changelogs/internal/newsfragments/2318.clarification new file mode 100644 index 00000000..f8108646 --- /dev/null +++ b/changelogs/internal/newsfragments/2318.clarification @@ -0,0 +1 @@ +Fix various typos throughout the specification. Contributed by @HarHarLinks. diff --git a/config/_default/hugo.toml b/config/_default/hugo.toml index fd403e34..a33f803b 100644 --- a/config/_default/hugo.toml +++ b/config/_default/hugo.toml @@ -65,7 +65,7 @@ description = "Home of the Matrix specification for decentralised communication" # Everything below this are Site Params [params] -copyright = "The Matrix.org Foundation CIC" +copyright = "The Matrix.org Foundation C.I.C." [params.version] # must be one of "unstable", "current", "historical" diff --git a/content/client-server-api/_index.md b/content/client-server-api/_index.md index 5f74ad40..d2427880 100644 --- a/content/client-server-api/_index.md +++ b/content/client-server-api/_index.md @@ -3320,7 +3320,7 @@ PUT /rooms/!roomid:domain/state/m.room.bgd.color ### Redactions Since events are extensible it is possible for malicious users and/or -servers to add keys that are, for example offensive or illegal. Since +servers to add keys that are, for example, offensive or illegal. Since some events cannot be simply deleted, e.g. membership events, we instead 'redact' events. This involves removing all keys from an event that are not required by the protocol. This stripped down event is thereafter @@ -3418,7 +3418,7 @@ This specification describes the following relationship types: * [Event replacements](#event-replacements). * [Event annotations](#event-annotations-and-reactions). * [Threads](#threading). -* [References](#reference-relations) +* [References](#reference-relations). #### Aggregations of child events diff --git a/content/client-server-api/modules/threading.md b/content/client-server-api/modules/threading.md index 9f87920a..e3365a0d 100644 --- a/content/client-server-api/modules/threading.md +++ b/content/client-server-api/modules/threading.md @@ -107,7 +107,7 @@ flag to `true`. ``` {{% boxes/note %}} -Clients which are acutely aware of threads (they do not render threads, but are otherwise +Clients which are aware of threads (they do not render threads, but are otherwise aware of the feature existing in the spec) can treat rich replies to an event with a `rel_type` of `m.thread` as a threaded reply, for conversation continuity on the threaded client's side. diff --git a/data/api/client-server/definitions/event_filter.yaml b/data/api/client-server/definitions/event_filter.yaml index d03c85da..ceb0d5bf 100644 --- a/data/api/client-server/definitions/event_filter.yaml +++ b/data/api/client-server/definitions/event_filter.yaml @@ -23,14 +23,14 @@ properties: not_senders: description: A list of sender IDs to exclude. If this list is absent then no senders are excluded. A matching sender will be excluded even if it is listed in the - `'senders'` filter. + `senders` filter. items: type: string type: array not_types: description: A list of event types to exclude. If this list is absent then no event types are excluded. A matching type will be excluded even if it is listed - in the `'types'` filter. A '*' can be used as a wildcard to match any sequence + in the `types` filter. A `*` can be used as a wildcard to match any sequence of characters. items: type: string @@ -43,7 +43,7 @@ properties: type: array types: description: A list of event types to include. If this list is absent then all - event types are included. A `'*'` can be used as a wildcard to match any sequence + event types are included. A `*` can be used as a wildcard to match any sequence of characters. items: type: string diff --git a/data/api/client-server/definitions/room_event_filter.yaml b/data/api/client-server/definitions/room_event_filter.yaml index ab8ef79e..6c9b705d 100644 --- a/data/api/client-server/definitions/room_event_filter.yaml +++ b/data/api/client-server/definitions/room_event_filter.yaml @@ -39,7 +39,7 @@ allOf: for more information. Defaults to `false`. not_rooms: description: A list of room IDs to exclude. If this list is absent then no rooms - are excluded. A matching room will be excluded even if it is listed in the `'rooms'` + are excluded. A matching room will be excluded even if it is listed in the `rooms` filter. items: type: string diff --git a/data/api/client-server/definitions/sync_filter.yaml b/data/api/client-server/definitions/sync_filter.yaml index 75544e94..f181aa22 100644 --- a/data/api/client-server/definitions/sync_filter.yaml +++ b/data/api/client-server/definitions/sync_filter.yaml @@ -17,15 +17,15 @@ properties: event_fields: description: List of event fields to include. If this list is absent then all fields are included. The entries are [dot-separated paths for each property](/appendices#dot-separated-property-paths) - to include. So ['content.body'] will include the 'body' field of the 'content' object. + to include. So `['content.body']` will include the `body` field of the `content` object. A server may include more fields than were requested. items: type: string type: array event_format: - description: The format to use for events. 'client' will return the events in - a format suitable for clients. 'federation' will return the raw event as received - over federation. The default is 'client'. + description: The format to use for events. `client` will return the events in + a format suitable for clients. `federation` will return the raw event as received + over federation. The default is `client`. enum: - client - federation @@ -45,7 +45,7 @@ properties: properties: not_rooms: description: A list of room IDs to exclude. If this list is absent then no rooms - are excluded. A matching room will be excluded even if it is listed in the `'rooms'` + are excluded. A matching room will be excluded even if it is listed in the `rooms` filter. This filter is applied before the filters in `ephemeral`, `state`, `timeline` or `account_data` items: @@ -65,7 +65,7 @@ properties: events that appear in the `ephemeral` property in the `/sync` response. include_leave: - description: Include rooms that the user has left in the sync, default false + description: Include rooms that the user has left in the sync. Defaults to `false`. type: boolean state: type: object diff --git a/data/api/client-server/list_public_rooms.yaml b/data/api/client-server/list_public_rooms.yaml index ef71ca63..c3e54403 100644 --- a/data/api/client-server/list_public_rooms.yaml +++ b/data/api/client-server/list_public_rooms.yaml @@ -226,7 +226,7 @@ paths: type: boolean description: |- Whether or not to include all known networks/protocols from - application services on the homeserver. Defaults to false. + application services on the homeserver. Defaults to `false`. example: false third_party_instance_id: type: string @@ -277,4 +277,4 @@ components: accessTokenQuery: $ref: definitions/security.yaml#/accessTokenQuery accessTokenBearer: - $ref: definitions/security.yaml#/accessTokenBearer \ No newline at end of file + $ref: definitions/security.yaml#/accessTokenBearer diff --git a/data/api/client-server/login.yaml b/data/api/client-server/login.yaml index 00827ce6..12696aa2 100644 --- a/data/api/client-server/login.yaml +++ b/data/api/client-server/login.yaml @@ -163,7 +163,7 @@ paths: known client device, a new device will be created. The given device ID must not be the same as a [cross-signing](/client-server-api/#cross-signing) key ID. - The server will auto-generate a device_id + The server will auto-generate a `device_id` if this is not specified. initial_device_display_name: type: string diff --git a/data/api/client-server/password_management.yaml b/data/api/client-server/password_management.yaml index b2d60559..3a1a570e 100644 --- a/data/api/client-server/password_management.yaml +++ b/data/api/client-server/password_management.yaml @@ -57,7 +57,7 @@ paths: type: boolean description: |- Whether the user's other access tokens, and their associated devices, should be - revoked if the request succeeds. Defaults to true. + revoked if the request succeeds. Defaults to `true`. When `false`, the server can still take advantage of the [soft logout method](/client-server-api/#soft-logout) for the user's remaining devices. diff --git a/data/api/client-server/registration.yaml b/data/api/client-server/registration.yaml index acb0b135..2813c0c2 100644 --- a/data/api/client-server/registration.yaml +++ b/data/api/client-server/registration.yaml @@ -126,7 +126,7 @@ paths: description: |- ID of the client device. If this does not correspond to a known client device, a new device will be created. The server - will auto-generate a device_id if this is not specified. + will auto-generate a `device_id` if this is not specified. example: GHTYAJCE initial_device_display_name: type: string @@ -139,11 +139,11 @@ paths: description: |- If true, an `access_token` and `device_id` should not be returned from this call, therefore preventing an automatic - login. Defaults to false. + login. Defaults to `false`. example: false refresh_token: type: boolean - description: If true, the client supports refresh tokens. + description: If `true`, the client supports refresh tokens. x-addedInMatrixVersion: "1.3" required: true responses: diff --git a/data/api/client-server/room_send.yaml b/data/api/client-server/room_send.yaml index 5c3d0019..7393d440 100644 --- a/data/api/client-server/room_send.yaml +++ b/data/api/client-server/room_send.yaml @@ -31,7 +31,7 @@ paths: The body of the request should be the content object of the event; the fields in this object will vary depending on the type of event. See - [Room Events](/client-server-api/#room-events) for the m. event specification. + [Room Events](/client-server-api/#room-events) for the `m.` event specification. Homeservers MUST allow clients to send `m.room.redaction` events with this endpoint for all room versions. In rooms with a version older than 11 they diff --git a/data/api/server-server/public_rooms.yaml b/data/api/server-server/public_rooms.yaml index 8beaecb2..41835f5a 100644 --- a/data/api/server-server/public_rooms.yaml +++ b/data/api/server-server/public_rooms.yaml @@ -49,7 +49,7 @@ paths: name: include_all_networks description: |- Whether or not to include all networks/protocols defined by application - services on the homeserver. Defaults to false. + services on the homeserver. Defaults to `false`. example: false schema: type: boolean @@ -121,7 +121,7 @@ paths: type: boolean description: |- Whether or not to include all known networks/protocols from - application services on the homeserver. Defaults to false. + application services on the homeserver. Defaults to `false`. example: false third_party_instance_id: type: string diff --git a/data/event-schemas/schema/core-event-schema/event.yaml b/data/event-schemas/schema/core-event-schema/event.yaml index 422ecd53..291187ee 100644 --- a/data/event-schemas/schema/core-event-schema/event.yaml +++ b/data/event-schemas/schema/core-event-schema/event.yaml @@ -7,8 +7,7 @@ properties: When interacting with the REST API, this is the HTTP body. type: object type: - description: The type of event. This SHOULD be namespaced similar to Java package - naming conventions e.g. 'com.example.subdomain.event.type' + description: The type of event, as defined by [the event type specification](/client-server-api/#types-of-room-events). type: string required: - type diff --git a/data/event-schemas/schema/m.room.server_acl.yaml b/data/event-schemas/schema/m.room.server_acl.yaml index c2ecf805..da490452 100644 --- a/data/event-schemas/schema/m.room.server_acl.yaml +++ b/data/event-schemas/schema/m.room.server_acl.yaml @@ -54,7 +54,7 @@ properties: type: boolean description: |- True to allow server names that are IP address literals. False to - deny. Defaults to true if missing or otherwise not a boolean. + deny. Defaults to `true` if missing or otherwise not a boolean. This is strongly recommended to be set to `false` as servers running with IP literal names are strongly discouraged in order to require diff --git a/layouts/_partials/events/render-event.html b/layouts/_partials/events/render-event.html index 30a20974..b4988ae1 100644 --- a/layouts/_partials/events/render-event.html +++ b/layouts/_partials/events/render-event.html @@ -49,7 +49,7 @@ {{ if $state_key }} - State key + State key: {{ $state_key.description | markdownify }} {{ end }}