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

Link to doc style doc

Browse source 
(and update it to cover extra section characters)
This commit is contained in:
Richard van der Hoff 2016-07-14 10:13:10 +01:00
parent 56547ad373
commit b5d68b8ff1
2 changed files with 14 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

3
CONTRIBUTING.rst
View file

@ -87,6 +87,9 @@ matrix-doc should be based on the ``master`` branch.)
Code style Code style
~~~~~~~~~~ ~~~~~~~~~~
The documentation style is described at
https://github.com/matrix-org/matrix-doc/blob/master/meta/documentation_style.rst.
Python code within the ``matrix-doc`` project should follow the same style as Python code within the ``matrix-doc`` project should follow the same style as
synapse, which is documented at synapse, which is documented at
https://github.com/matrix-org/synapse/tree/master/docs/code_style.rst. https://github.com/matrix-org/synapse/tree/master/docs/code_style.rst.

16
meta/documentation_style.rst
View file

@ -19,11 +19,17 @@ RST support lots of different punctuation characters for underlines on sections.
Content in the specification MUST use the same characters in order for the Content in the specification MUST use the same characters in order for the
complete specification to be merged correctly. These characters are: complete specification to be merged correctly. These characters are:
- ``=`` : Top-level sections - ``=``
- ``-`` : Second-level sections - ``-``
- ``~`` : Third-level sections - ``~``
- ``+`` : Fourth-level sections - ``+``
- You should rethink your document layout if you require a fifth level. - ``^``
- `````
- ``@``
- ``:``
If you find yourself using ``^`` or beyond, you should rethink your document
layout if possible.
TODOs TODOs
----- -----