diff options
| author | Kegan Dougal <kegan@matrix.org> | 2014-09-09 15:13:50 -0700 |
|---|---|---|
| committer | Kegan Dougal <kegan@matrix.org> | 2014-09-09 15:13:50 -0700 |
| commit | 2bd4346075b119d48afa676dcc883a51199119f2 (patch) | |
| tree | 526d32519d1a3f79fb160b26ae14598f508463ba /docs | |
| parent | Extra restrictions to make parsing easier. (diff) | |
| download | synapse-2bd4346075b119d48afa676dcc883a51199119f2.tar.xz | |
More rst formatting.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/human-id-rules.rst | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/human-id-rules.rst b/docs/human-id-rules.rst index 6e63bc43a2..3a1ff39892 100644 --- a/docs/human-id-rules.rst +++ b/docs/human-id-rules.rst @@ -42,8 +42,8 @@ Checks - Language sets from CLDR dataset. - Treated in segments (localpart, domain) - Additional restrictions for ease of processing IDs. - - Room alias localparts MUST NOT have ``#`` or ``:``. - - User ID localparts MUST NOT have ``@`` or ``:``. + - Room alias localparts MUST NOT have ``#`` or ``:``. + - User ID localparts MUST NOT have ``@`` or ``:``. Rejecting --------- @@ -54,12 +54,13 @@ Rejecting - Any home server whose domain does not pass this check, MUST use their punycode domain name instead of the IDN, to prevent other home servers rejecting you. - Error code is ``M_FAILED_HUMAN_ID_CHECK``. (generic enough for both failing - due to homograph attacks, and failing due to including ``:``s, etc) + due to homograph attacks, and failing due to including ``:`` s, etc) - Error message MAY go into further information about which characters were rejected and why. - Error message SHOULD contain a ``failed_keys`` key which contains an array - of strings which represent the keys which failed the check e.g: - - ``failed_keys: [ user_id, room_alias ]`` + of strings which represent the keys which failed the check e.g:: + + failed_keys: [ user_id, room_alias ] Other considerations -------------------- |