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

Clarify template suffixes

Browse source
This commit is contained in:
Kegan Dougal 2015-09-28 14:03:54 +01:00
parent 643468e914
commit 70518ae655
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
specification/modules/_template.rst
View file

@ -23,14 +23,16 @@ m.example.event.type
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
There should be JSON Schema docs for this event. Once there is JSON schema, There should be JSON Schema docs for this event. Once there is JSON schema,
there will be a template variable with dots in the event type replaced with there will be a template variable with dots in the event type replaced with
underscores. You can insert a template like so: underscores and the suffix ``_event``. You can insert a template like so:
{{m_example_event_type_event}} {{m_example_event_type_event}}
Client behaviour Client behaviour
---------------- ----------------
List any new HTTP endpoints. These endpoints should be docced using Swagger. You List any new HTTP endpoints. These endpoints should be docced using Swagger.
can insert a template for swagger docs like so: Once there is Swagger, there will be a template variable based on the name of
the YAML file with the suffix ``_http_api``. You can insert a template for
swagger docs like so:
{{name-of-yaml-file-without-file-ext_http_api}} {{name-of-yaml-file-without-file-ext_http_api}}