mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-08-05 07:27:52 +02:00
Compare commits
2 commits
160339e580
...
31aa625a2a
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
31aa625a2a | ||
|
|
6cfb653e65 |
2
.github/workflows/spell-check.yaml
vendored
2
.github/workflows/spell-check.yaml
vendored
|
|
@ -14,6 +14,6 @@ jobs:
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Check spelling of proposals
|
- name: Check spelling of proposals
|
||||||
uses: crate-ci/typos@f2c1f08a7b3c1b96050cb786baaa2a94797bdb7d # v1.20.10
|
uses: crate-ci/typos@bbaefadf97b0ec5fdc942684b647f1a6ab250274 # v1.46.0
|
||||||
with:
|
with:
|
||||||
config: ${{github.workspace}}/.github/_typos.toml
|
config: ${{github.workspace}}/.github/_typos.toml
|
||||||
|
|
|
||||||
1
changelogs/appendices/newsfragments/2369.clarification
Normal file
1
changelogs/appendices/newsfragments/2369.clarification
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Fix various typos throughout the specification.
|
||||||
2
changelogs/internal/newsfragments/2366.clarification
Normal file
2
changelogs/internal/newsfragments/2366.clarification
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
Clarify use of UK vs US English in documentation style doc.
|
||||||
|
|
||||||
1
changelogs/internal/newsfragments/2369.clarification
Normal file
1
changelogs/internal/newsfragments/2369.clarification
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Update and fix GitHub Actions.
|
||||||
1
changelogs/olm_megolm/newsfragments/2369.clarification
Normal file
1
changelogs/olm_megolm/newsfragments/2369.clarification
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Fix various typos throughout the specification.
|
||||||
|
|
@ -940,7 +940,7 @@ they need to go, however they should also be aware of [issue
|
||||||
|
|
||||||
A room (or room permalink) which isn't using a room alias should supply
|
A room (or room permalink) which isn't using a room alias should supply
|
||||||
at least one server using `via` in the URI's query string. Multiple servers
|
at least one server using `via` in the URI's query string. Multiple servers
|
||||||
can be specified by including multuple `via` parameters.
|
can be specified by including multiple `via` parameters.
|
||||||
|
|
||||||
The values of `via` are intended to be passed along on the
|
The values of `via` are intended to be passed along on the
|
||||||
[Client Server `/join/{roomIdOrAlias}` API](/client-server-api/#post_matrixclientv3joinroomidoralias).
|
[Client Server `/join/{roomIdOrAlias}` API](/client-server-api/#post_matrixclientv3joinroomidoralias).
|
||||||
|
|
|
||||||
|
|
@ -305,7 +305,7 @@ has proven ownership of.
|
||||||
Eve; Eve cannot decrypt it, but forwards it to Bob. Bob believes the
|
Eve; Eve cannot decrypt it, but forwards it to Bob. Bob believes the
|
||||||
Alice sent the message to him, whereas Alice intended it to go to Eve.
|
Alice sent the message to him, whereas Alice intended it to go to Eve.
|
||||||
|
|
||||||
This is prevented by Alice including the user ID of the intended recpient
|
This is prevented by Alice including the user ID of the intended recipient
|
||||||
(Eve) in the plain-text of the pre-key message. Bob can now tell that the
|
(Eve) in the plain-text of the pre-key message. Bob can now tell that the
|
||||||
message was meant for Eve rather than him.
|
message was meant for Eve rather than him.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -19,7 +19,7 @@ nested titles (h6, or 6 `#` characters) and instead re-evaluate the document str
|
||||||
Correct capitalisation for long section names
|
Correct capitalisation for long section names
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Headings should be in `sentence case <https://apastyle.apa.org/style-grammar-guidelines/capitalization/sentence-case>`,
|
Headings should be in `sentence case <https://apastyle.apa.org/style-grammar-guidelines/capitalization/sentence-case>`_,
|
||||||
as represented by this document.
|
as represented by this document.
|
||||||
|
|
||||||
TODOs
|
TODOs
|
||||||
|
|
@ -47,7 +47,20 @@ General
|
||||||
* Try to write clearly and unambiguously. Remember that many readers will not
|
* Try to write clearly and unambiguously. Remember that many readers will not
|
||||||
have English as their first language.
|
have English as their first language.
|
||||||
|
|
||||||
* Prefer British English (colour, -ise) to American English.
|
* The Matrix spec uses British English rather than American English. For example, the
|
||||||
|
words "colour" and "authorise" use British spellings. The
|
||||||
|
``join_authorised_via_users_server`` property in ``m.room.member`` events is
|
||||||
|
spelt accordingly.
|
||||||
|
|
||||||
|
* This extends to terms defined in other specifications: for example, in the
|
||||||
|
context of OAuth 2.0, we refer to an "authorisation code grant", even though
|
||||||
|
RFC6749 uses the spelling "authorization".
|
||||||
|
|
||||||
|
Of course, identifiers used within the protocol itself must use the
|
||||||
|
spellings defined by the protocol. So, for example, the
|
||||||
|
``authorization_endpoint`` property in the `OAuth 2.0
|
||||||
|
metadata <https://spec.matrix.org/v1.18/client-server-api/#get_matrixclientv1auth_metadata>`_
|
||||||
|
uses the same spelling as defined in `RFC8414 <https://www.rfc-editor.org/rfc/rfc8414#section-2>`_.
|
||||||
|
|
||||||
* The word "homeserver" is spelt thus (rather than "home server", "Homeserver",
|
* The word "homeserver" is spelt thus (rather than "home server", "Homeserver",
|
||||||
or (argh) "Home Server"). However, an identity server is two words.
|
or (argh) "Home Server"). However, an identity server is two words.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue