wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge branch 'spec-edits-cleanup' into spec-file-structure

Browse source
This commit is contained in:
Kegan Dougal 2015-09-18 11:10:17 +01:00
commit 91d674b3c7
2 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
specification/00_basis.rst
View file

@ -444,7 +444,7 @@ The ``error`` string will be a human-readable error message, usually a sentence
explaining what went wrong. The ``errcode`` string will be a unique string explaining what went wrong. The ``errcode`` string will be a unique string
which can be used to handle an error message e.g. ``M_FORBIDDEN``. These error which can be used to handle an error message e.g. ``M_FORBIDDEN``. These error
codes should have their namespace first in ALL CAPS, followed by a single _ to codes should have their namespace first in ALL CAPS, followed by a single _ to
ease separating the namespace from the error code.. For example, if there was a ease separating the namespace from the error code. For example, if there was a
custom namespace ``com.mydomain.here``, and a custom namespace ``com.mydomain.here``, and a
``FORBIDDEN`` code, the error code should look like ``FORBIDDEN`` code, the error code should look like
``COM.MYDOMAIN.HERE_FORBIDDEN``. There may be additional keys depending on the ``COM.MYDOMAIN.HERE_FORBIDDEN``. There may be additional keys depending on the

6
specification/45_typing_notifications.rst
View file

@ -11,9 +11,9 @@ To set "I am typing for the next N msec"::
# timeout is in milliseconds; suggested no more than 20 or 30 seconds # timeout is in milliseconds; suggested no more than 20 or 30 seconds
This should be re-sent by the client to continue informing the server the user This should be re-sent by the client to continue informing the server the user
is still typing; I suggest a safety margin of 5 seconds before the expected is still typing; a safety margin of 5 seconds before the expected
timeout runs out. Just keep declaring a new timeout, it will replace the old timeout runs out is recommended. Just keep declaring a new timeout, it will
one. replace the old one.
To set "I am no longer typing":: To set "I am no longer typing"::