mirror/evennia
3
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-08-18 03:05:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor typo-fix to coding style info.

Browse Source
This commit is contained in:
Griatch
2017-02-12 11:17:31 +01:00
parent 6d24f82054
commit fe89f2eb52
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
CODING_STYLE.md
View File

@ -52,8 +52,9 @@ are useful in the game ...
Sectioning (`# title`, `## subtile` etc) should not be used in
freeform docstrings - this will confuse the sectioning of the auto
documentation page and the auto-api will create this automatically.
Use **section** with bold markers if a section is needed. Otherwise
markdown should be used as needed to format the text.
Write just the section name bolded on its own line to mark a section.
Beyond sections markdown should be used as needed to format
the text.
Code examples should use [multi-line syntax highlighting][markdown-hilight]
to mark multi-line code blocks, using the "python" identifier. Just