|
| 1 | +# MSCXXXX: Standardize the spec on US English 🇺🇸 |
| 2 | + |
| 3 | +The spec's house style currently recommends British over American English[^1]. This has historically |
| 4 | +not been strongly enforced, however. For instance, there are multiple instances of both "authorize" |
| 5 | +(🇺🇸) and "authorise" (🇬🇧) in the spec text as well as in identifiers such as `M_UNAUTHORIZED` and |
| 6 | +`m.unauthorised`. While this inconsistency usually doesn't hinder readability, it negatively impacts |
| 7 | +searchability and general consistency of the spec. |
| 8 | + |
| 9 | +Standardizing on British English is difficult though because many other technical standards use the |
| 10 | +American spelling. For instance, RFC6749 defines the term "authorization server"[^2] as well as the |
| 11 | +`authorization_code` grant type[^3] as an identifier. Using the British spelling when covering these |
| 12 | +in the Matrix spec would be confusing for terms and impossible for identifiers. |
| 13 | + |
| 14 | +For comparison, the following noteworthy standards use American English: |
| 15 | + |
| 16 | +- W3C[^4] |
| 17 | +- IEEE[^5] |
| 18 | +- ANSI[^6] |
| 19 | + |
| 20 | +In contrast, the following standards enforce British English: |
| 21 | + |
| 22 | +- ISO[^7] |
| 23 | + |
| 24 | +Lastly, these standards allow either of the two as long as they are used consistently within a |
| 25 | +document: |
| 26 | + |
| 27 | +- RFCs[^8] |
| 28 | + |
| 29 | +Given the dominant use of US English in other standards and the unsolvable problem of localizing |
| 30 | +identifiers, this proposal seeks to standardize Matrix on US English. |
| 31 | + |
| 32 | +## Proposal |
| 33 | + |
| 34 | +The spec's house rules are updated to RECOMMEND the American over the British spelling. Existing |
| 35 | +spec text and identifiers are not updated but MAY be migrated in future. Any new spec text or |
| 36 | +identifiers SHOULD use the American spelling. |
| 37 | + |
| 38 | +## Potential issues |
| 39 | + |
| 40 | +This proposal doesn't directly resolve the current inconsistency of both spellings being used in the |
| 41 | +spec simultaneously. It paves the way for an eventually consistent spelling without the need for |
| 42 | +busywork, however. |
| 43 | + |
| 44 | +Many of the spec contributors and especially members of the core team have a British background. |
| 45 | +Departing from their native spelling might feel odd for some. |
| 46 | + |
| 47 | +Matrix has a huge center of mass in Europe. In a time of transatlantic tension, committing to the |
| 48 | +American spelling might feel uncomfortable to some. Language and politics should not be conflated, |
| 49 | +however. |
| 50 | + |
| 51 | +## Alternatives |
| 52 | + |
| 53 | +We could enforce the British spelling in spec text and identifiers that are not inherited from other |
| 54 | +standards. To aid searchability, a legend of common words that differ in spelling could be included |
| 55 | +at the bottom of each page. |
| 56 | + |
| 57 | + authorise -> authorize |
| 58 | + authorisation -> authorization |
| 59 | + ... |
| 60 | + |
| 61 | +A reader searching for "authorization" would at least land on the legend and receive a cue to search |
| 62 | +for "authorisation" instead. This feels more complicated and less practical than standardizing on US |
| 63 | +English, however. |
| 64 | + |
| 65 | +## Security considerations |
| 66 | + |
| 67 | +None. |
| 68 | + |
| 69 | +## Unstable prefix |
| 70 | + |
| 71 | +None. |
| 72 | + |
| 73 | +## Dependencies |
| 74 | + |
| 75 | +None. |
| 76 | + |
| 77 | +[^1]: <https://github.com/matrix-org/matrix-spec/blob/bb3daafe96cce7ec7e139223429d2ea93e087c08/meta/documentation_style.rst?plain=1#L50> |
| 78 | + |
| 79 | +[^2]: <https://datatracker.ietf.org/doc/html/rfc6749#section-1.1> |
| 80 | + |
| 81 | +[^3]: <https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.3> |
| 82 | + |
| 83 | +[^4]: <https://www.w3.org/guide/manual-of-style/#Spelling> |
| 84 | + |
| 85 | +[^5]: <https://sagroups.ieee.org/1588/wp-content/uploads/sites/144/2020/05/2014-ieee-sa-standards-style-manual.pdf> |
| 86 | + "under 19.2 c" |
| 87 | + |
| 88 | +[^6]: <https://www.ansi.org/american-national-standards/ans-introduction/essential-requirements> |
| 89 | + "4.0 only mentions "English" but it is the **American** National Standards Institute" |
| 90 | + |
| 91 | +[^7]: <https://www.iso.org/ISO-house-style.html#spelling> |
| 92 | + |
| 93 | +[^8]: <https://www.rfc-editor.org/rfc/rfc7322.html#section-3.1> |
0 commit comments