Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor refactoring of text.

Browse source
This commit is contained in:
Griatch 2017-02-12 13:23:24 +01:00
parent be107814e5
commit 24adc5286b
1 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

10
CODING_STYLE.md
View file

@ -183,11 +183,12 @@ class docstrings to represent the in-game help entry for that command.
So for the default look of Command class docstrings see instead So for the default look of Command class docstrings see instead
[the default command documentation policy][command-docstrings]. [the default command documentation policy][command-docstrings].
### Changing automatic docstring format in PyCharm ### Automatic docstring templating
Pycharm will generate docstring stubs automatically for you, but the The Python IDE [Pycharm][pycharm] will generate Evennia-friendly
default format is reStructuredText. To change it to google-style, docstring stubs automatically for you, but the default format is
follow [this guide][pycharm-guide]. reStructuredText. To change it to Evennia's Google-style, follow
[this guide][pycharm-guide].
## Ask Questions! ## Ask Questions!
@ -202,4 +203,5 @@ or in the chat.
[githubmarkdown]: https://help.github.com/articles/github-flavored-markdown/ [githubmarkdown]: https://help.github.com/articles/github-flavored-markdown/
[markdown-hilight]: https://help.github.com/articles/github-flavored-markdown/#syntax-highlighting [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 [command-docstrings]: https://github.com/evennia/evennia/wiki/Using%20MUX%20As%20a%20Standard#documentation-policy
[pycharm]: https://www.jetbrains.com/pycharm/
[pycharm-guide]: https://www.jetbrains.com/help/pycharm/2016.3/python-integrated-tools.html [pycharm-guide]: https://www.jetbrains.com/help/pycharm/2016.3/python-integrated-tools.html