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

Fix all naming cases of "identity service"

Browse source 
Fixes https://github.com/matrix-org/matrix-doc/issues/1396

Includes some "homeserver" fixes too. This commit does not include historical documentation or notes.
This commit is contained in:
Travis Ralston 2018-08-30 18:19:35 -06:00
parent 683072e624
commit cc0badaaa1
14 changed files with 90 additions and 90 deletions
Download patch file Download diff file Expand all files Collapse all files

16
meta/documentation_style.rst
View file

@ -69,10 +69,10 @@ have English as their first language.
Prefer British English (colour, -ise) to American English.
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 service is two words.
.. Rationale: "homeserver" distinguishes from a "home server" which is a server
you have at home. "Identity server" is clear, whereas "identityserver" is
.. Rationale: "homeserver" distinguishes from a "home server" which is a server
you have at home. "Identity Service" is clear, whereas "identityservice" is
horrible.
Lists should:
@ -91,9 +91,9 @@ When writing OpenAPI specifications for the API endpoints, follow these rules:
* ``description``: a longer description of the behaviour of this API, written
in complete sentences. Use multiple paragraphs if necessary.
Example:
Example:
This API sends an event to the room. The server must ensure that the user
has permission to post events to this room.
@ -106,7 +106,7 @@ When writing OpenAPI specifications for the API endpoints, follow these rules:
The description is also the place to define default values for optional
properties. Use the wording "Defaults to X [if unspecified]."
Some descriptions start with the word "Optional" to explicitly mark optional
Some descriptions start with the word "Optional" to explicitly mark optional
properties and parameters. This is redundant. Instead, use the ``required``
property to mark those that are required.