Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-16 12:56:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update CODING_STYLE.md

Browse source
This commit is contained in:
Griatch 2015-03-08 13:23:32 +01:00
parent b31fa905d6
commit c982f7bf80
1 changed files with 4 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

17
CODING_STYLE.md
View file

@ -58,19 +58,9 @@ are useful in the game ...
"""
```
Code examples should use the `\`\`\`python` marker to mark
multi-line code blocks, such as
```
\`\`\`python
code here
\`\`\`
```
Just indenting will not produce the code desired.
Code examples should use [multi-line syntax highlighting][markdown-hilight] to mark
multi-line code blocks, using the "python" identifier. Just indenting
code blocks (common in markdown) will not produce the desired look.
### Class docstrings
@ -159,3 +149,4 @@ or in the chat.
[pep8tool]: https://pypi.python.org/pypi/pep8
[googlestyle]: http://google-styleguide.googlecode.com/svn/trunk/pyguide.html?showone=Comments#Comments
[githubmarkdown]: https://help.github.com/articles/github-flavored-markdown/
[markdown-hilight]: https://help.github.com/articles/github-flavored-markdown/#syntax-highlighting