Skip to content

Commit aab2d58

Browse files
committed
Fix spelling and grammar issues
Signed-off-by: Philipp Emanuel Weidmann <[email protected]>
1 parent 8d4d6a1 commit aab2d58

File tree

10 files changed

+78
-78
lines changed

10 files changed

+78
-78
lines changed

specification/appendices/identifier_grammar.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ The complete grammar for a legal user ID is::
152152
set. User IDs are primarily intended for use as an identifier at the protocol
153153
level, and their use as a human-readable handle is of secondary
154154
benefit. Furthermore, they are useful as a last-resort differentiator between
155-
users with similar display names. Allowing the full unicode character set
155+
users with similar display names. Allowing the full Unicode character set
156156
would make very difficult for a human to distinguish two similar user IDs. The
157157
limited character set used has the advantage that even a user unfamiliar with
158158
the Latin alphabet should be able to distinguish similar user IDs manually, if
@@ -190,7 +190,7 @@ history includes events with a ``sender`` which does not conform. In order to
190190
handle these rooms successfully, clients and servers MUST accept user IDs with
191191
localparts from the expanded character set::
192192

193-
extended_user_id_char = %x21-39 / %x3B-7E ; all ascii printing chars except :
193+
extended_user_id_char = %x21-39 / %x3B-7E ; all ASCII printing chars except :
194194

195195
Mapping from other character sets
196196
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
@@ -251,8 +251,8 @@ risk of clashes of identifiers between different homeservers. There is no
251251
implication that the room or event in question is still available at the
252252
corresponding homeserver.
253253

254-
Event IDs and Room IDs are case-sensitive. They are not meant to be human
255-
readable. They are intended to be treated as fully opaque strings by clients.
254+
Event IDs and Room IDs are case-sensitive. They are not meant to be human-readable.
255+
They are intended to be treated as fully opaque strings by clients.
256256

257257
.. TODO-spec
258258
What is the grammar for the opaque part? https://matrix.org/jira/browse/SPEC-389
@@ -326,7 +326,7 @@ parameter is only used in the case of permalinks where an event ID is referenced
326326
The matrix.to URI, when referenced, must always start with ``https://matrix.to/#/``
327327
followed by the identifier.
328328

329-
The ``<additional arguments>`` and the preceeding question mark are optional and
329+
The ``<additional arguments>`` and the preceding question mark are optional and
330330
only apply in certain circumstances, documented below.
331331

332332
Clients should not rely on matrix.to URIs falling back to a web server if accessed
@@ -379,7 +379,7 @@ are picked is left as an implementation detail, however the current recommendati
379379
to pick 3 unique servers based on the following criteria:
380380

381381
* The first server should be the server of the highest power level user in the room,
382-
provided they are at least power level 50. If no user meets this criteria, pick the
382+
provided they are at least power level 50. If no user meets these criteria, pick the
383383
most popular server in the room (most joined users). The rationale for not picking
384384
users with power levels under 50 is that they are unlikely to be around into the
385385
distant future while higher ranking users (and therefore servers) are less likely

specification/appendices/signing_json.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Canonical JSON
2929
~~~~~~~~~~~~~~
3030

3131
We define the canonical JSON encoding for a value to be the shortest UTF-8 JSON
32-
encoding with dictionary keys lexicographically sorted by unicode codepoint.
32+
encoding with dictionary keys lexicographically sorted by Unicode codepoint.
3333
Numbers in the JSON must be integers in the range ``[-(2**53)+1, (2**53)-1]``.
3434

3535
We pick UTF-8 as the encoding as it should be available to all platforms and
@@ -63,7 +63,7 @@ using this representation.
6363
separators=(',',':'),
6464
# Sort the keys of dictionaries.
6565
sort_keys=True,
66-
# Encode the resulting unicode as UTF-8 bytes.
66+
# Encode the resulting Unicode as UTF-8 bytes.
6767
).encode("UTF-8")
6868
6969
Grammar

specification/appendices/threat_model.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ victim in order to:
2828
Threat: Resource Exhaustion
2929
+++++++++++++++++++++++++++
3030

31-
An attacker could cause the victims server to exhaust a particular resource
31+
An attacker could cause the victim's server to exhaust a particular resource
3232
(e.g. open TCP connections, CPU, memory, disk storage)
3333

3434
Threat: Unrecoverable Consistency Violations

specification/application_service_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ Authorization
194194
Homeservers MUST include a query parameter named ``access_token`` containing the
195195
``hs_token`` from the application service's registration when making requests to
196196
the application service. Application services MUST verify the provided ``access_token``
197-
matches their known ``hs_token``, failing the request with a ``M_FORBIDDEN`` error
197+
matches their known ``hs_token``, failing the request with an ``M_FORBIDDEN`` error
198198
if it does not match.
199199

200200
Legacy routes
@@ -206,8 +206,8 @@ service specification now defines a version on all endpoints to be more compatib
206206
with the rest of the Matrix specification and the future.
207207

208208
Homeservers should attempt to use the specified endpoints first when communicating
209-
with application services. However, if the application service receives an http status
210-
code that does not indicate success (ie: 404, 500, 501, etc) then the homeserver
209+
with application services. However, if the application service receives an HTTP status
210+
code that does not indicate success (i.e.: 404, 500, 501, etc) then the homeserver
211211
should fall back to the older endpoints for the application service.
212212

213213
The older endpoints have the exact same request body and response format, they

specification/client_server_api.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ Other error codes the client might encounter are:
186186
permits, for example, email addresses from a particular domain.
187187

188188
:``M_SERVER_NOT_TRUSTED``:
189-
The client's request used a third party server, eg. identity server, that this server does not trust.
189+
The client's request used a third party server, e.g. identity server, that this server does not trust.
190190

191191
:``M_UNSUPPORTED_ROOM_VERSION``:
192192
The client's request to create a room used a room version that the server does not support.
@@ -228,8 +228,8 @@ Other error codes the client might encounter are:
228228
may reach a resource limit if it starts using too much memory or disk space. The
229229
error MUST have an ``admin_contact`` field to provide the user receiving the error
230230
a place to reach out to. Typically, this error will appear on routes which attempt
231-
to modify state (eg: sending messages, account data, etc) and not routes which only
232-
read state (eg: ``/sync``, get account data, etc).
231+
to modify state (e.g.: sending messages, account data, etc) and not routes which only
232+
read state (e.g.: ``/sync``, get account data, etc).
233233

234234
:``M_CANNOT_LEAVE_SERVER_NOTICE_ROOM``:
235235
The user is unable to reject an invite to join the server notices room. See the
@@ -266,8 +266,8 @@ to pre-flight requests and supply Cross-Origin Resource Sharing (CORS) headers o
266266
all requests.
267267

268268
Servers MUST expect that clients will approach them with ``OPTIONS`` requests,
269-
allowing clients to discover the CORS headers. All endpoints in this specification s
270-
upport the ``OPTIONS`` method, however the server MUST NOT perform any logic defined
269+
allowing clients to discover the CORS headers. All endpoints in this specification
270+
support the ``OPTIONS`` method, however the server MUST NOT perform any logic defined
271271
for the endpoints when approached with an ``OPTIONS`` request.
272272

273273
When a client approaches the server with a request, the server should respond with
@@ -438,7 +438,7 @@ homeserver may provide many different ways of authenticating, such as
438438
user/password auth, login via a single-sign-on server (SSO), etc. This
439439
specification does not define how homeservers should authorise their users but
440440
instead defines the standard interface which implementations should follow so
441-
that ANY client can login to ANY homeserver.
441+
that ANY client can log in to ANY homeserver.
442442

443443
The process takes the form of one or more 'stages'. At each stage the client
444444
submits a set of data for a given authentication type and awaits a response
@@ -707,7 +707,7 @@ For example, to authenticate using the user's Matrix ID, clients would submit:
707707
}
708708
709709
Alternatively reply using a 3PID bound to the user's account on the homeserver
710-
using the |/account/3pid|_ API rather then giving the ``user`` explicitly as
710+
using the |/account/3pid|_ API rather than giving the ``user`` explicitly as
711711
follows:
712712

713713
.. code:: json
@@ -827,7 +827,7 @@ Dummy Auth
827827
Dummy authentication always succeeds and requires no extra parameters. Its
828828
purpose is to allow servers to not require any form of User-Interactive
829829
Authentication to perform a request. It can also be used to differentiate
830-
flows where otherwise one flow would be a subset of another flow. eg. if
830+
flows where otherwise one flow would be a subset of another flow. e.g. if
831831
a server offers flows ``m.login.recaptcha`` and ``m.login.recaptcha,
832832
m.login.email.identity`` and the client completes the recaptcha stage first,
833833
the auth would succeed with the former flow, even if the client was intending
@@ -878,7 +878,7 @@ to be defined in an embedded browser, or to use the HTML5 `cross-document
878878
messaging <https://www.w3.org/TR/webmessaging/#web-messaging>`_ API, to receive
879879
a notification that the authentication stage has been completed.
880880

881-
Once a client receives the notificaton that the authentication stage has been
881+
Once a client receives the notification that the authentication stage has been
882882
completed, it should resubmit the request with an auth dict with just the
883883
session ID:
884884

@@ -891,19 +891,19 @@ session ID:
891891
892892
Example
893893
<<<<<<<
894-
A client webapp might use the following javascript to open a popup window which will
894+
A client webapp might use the following JavaScript to open a popup window which will
895895
handle unknown login types:
896896

897897
.. code:: javascript
898898
899899
/**
900900
* Arguments:
901-
* homeserverUrl: the base url of the homeserver (eg "https://matrix.org")
901+
* homeserverUrl: the base url of the homeserver (e.g. "https://matrix.org")
902902
*
903-
* apiEndpoint: the API endpoint being used (eg
903+
* apiEndpoint: the API endpoint being used (e.g.
904904
* "/_matrix/client/%CLIENT_MAJOR_VERSION%/account/password")
905905
*
906-
* loginType: the loginType being attempted (eg "m.login.recaptcha")
906+
* loginType: the loginType being attempted (e.g. "m.login.recaptcha")
907907
*
908908
* sessionID: the session ID given by the homeserver in earlier requests
909909
*
@@ -930,7 +930,7 @@ handle unknown login types:
930930
};
931931
932932
request({
933-
method:'POST', url:apiEndpint, json:requestBody,
933+
method:'POST', url:apiEndpoint, json:requestBody,
934934
}, onComplete);
935935
};
936936
@@ -1044,7 +1044,7 @@ request as follows:
10441044
}
10451045
10461046
Alternatively, a client can use a 3PID bound to the user's account on the
1047-
homeserver using the |/account/3pid|_ API rather then giving the ``user``
1047+
homeserver using the |/account/3pid|_ API rather than giving the ``user``
10481048
explicitly, as follows:
10491049

10501050
.. code:: json
@@ -1130,7 +1130,7 @@ can be proxied (bound) to the identity server in many cases.
11301130
This section deals with two terms: "add" and "bind". Where "add" (or "remove")
11311131
is used, it is speaking about an identifier that was not bound to an identity
11321132
server. As a result, "bind" (or "unbind") references an identifier that is found
1133-
in an identity server. Note that an identifer can be added and bound at the same
1133+
in an identity server. Note that an identifier can be added and bound at the same
11341134
time, depending on context.
11351135

11361136
{{administrative_contact_cs_http_api}}
@@ -1745,7 +1745,7 @@ same way a server does.
17451745
except those protected by the redaction algorithm. For example,
17461746
a redacted ``join`` event will still result in the user being considered joined.
17471747
Similarly, a redacted topic does not necessarily cause the topic to revert to
1748-
what is was prior to the event - it causes the topic to be removed from the room.
1748+
what it was prior to the event - it causes the topic to be removed from the room.
17491749

17501750

17511751
Events
@@ -1977,9 +1977,9 @@ many places of a client's display, changes to these fields cause an automatic
19771977
propagation event to occur, informing likely-interested parties of the new
19781978
values. This change is conveyed using two separate mechanisms:
19791979

1980-
- a ``m.room.member`` event (with a ``join`` membership) is sent to every room
1980+
- an ``m.room.member`` event (with a ``join`` membership) is sent to every room
19811981
the user is a member of, to update the ``displayname`` and ``avatar_url``.
1982-
- a ``m.presence`` presence status update is sent, again containing the new
1982+
- an ``m.presence`` presence status update is sent, again containing the new
19831983
values of the ``displayname`` and ``avatar_url`` keys, in addition to the
19841984
required ``presence`` key containing the current presence state of the user.
19851985

specification/identity_service_api.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ Terms of service
225225

226226
Identity Servers are encouraged to have terms of service (or similar policies) to
227227
ensure that users have agreed to their data being processed by the server. To facilitate
228-
this, an identity server can respond to almost any authenticated API endpoint with a
228+
this, an identity server can respond to almost any authenticated API endpoint with an
229229
HTTP 403 and the error code ``M_TERMS_NOT_SIGNED``. The error code is used to indicate
230230
that the user must accept new terms of service before being able to continue.
231231

@@ -421,7 +421,7 @@ i.e. I can claim that any email address I own is associated with
421421
Sessions are time-limited; a session is considered to have been modified when
422422
it was created, and then when a validation is performed within it. A session can
423423
only be checked for validation, and validation can only be performed within a
424-
session, within a 24 hour period since its most recent modification. Any
424+
session, within a 24-hour period since its most recent modification. Any
425425
attempts to perform these actions after the expiry will be rejected, and a new
426426
session should be created and used instead.
427427

specification/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@ Profiles
431431
~~~~~~~~
432432

433433
Users may publish arbitrary key/value data associated with their account - such
434-
as a human readable display name, a profile photo URL, contact information
434+
as a human-readable display name, a profile photo URL, contact information
435435
(email address, phone numbers, website URLs etc).
436436

437437
.. TODO

0 commit comments

Comments
 (0)