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

Update CODING_STYLE.md

Browse source
This commit is contained in:
Griatch 2015-09-25 11:04:30 +02:00
parent 1d17302d16
commit 5ce222ea66
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
CODING_STYLE.md
View file

@ -180,6 +180,12 @@ good idea, for a small number of arguments though, just using `Args:`
and marking keywords as `optional` will shorten the docstring and make
it easier to read.
### Default Commands
These represent a special case since Commands in Evennia are using their
class docstrings to represent the in-game help entry for that command.
So for the default look of Command class docstrings see instead
[the default command documentation policy][command-docstrings].
## Ask Questions!
@ -193,3 +199,4 @@ or in the chat.
[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
[command-docstrings]: https://github.com/evennia/evennia/wiki/Using%20MUX%20As%20a%20Standard#documentation-policy