From c982f7bf808d7d7e4826856d2a0744fba5ec9e93 Mon Sep 17 00:00:00 2001 From: Griatch Date: Sun, 8 Mar 2015 13:23:32 +0100 Subject: [PATCH] Update CODING_STYLE.md --- CODING_STYLE.md | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/CODING_STYLE.md b/CODING_STYLE.md index 03e076c9eb..5842413c9d 100644 --- a/CODING_STYLE.md +++ b/CODING_STYLE.md @@ -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