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 
Making a note about changing to google-style docstrings in pycharm
This commit is contained in:
TehomCD 2017-02-12 05:50:10 -05:00 • committed by Griatch
parent 7453cf325a
commit be107814e5
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

@ -183,6 +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
[the default command documentation policy][command-docstrings].
### Changing automatic docstring format in PyCharm
Pycharm will generate docstring stubs automatically for you, but the
default format is reStructuredText. To change it to google-style,
follow [this guide][pycharm-guide].
## Ask Questions!
If any of the rules outlined in PEP 8 or in the sections above doesn't
@ -196,3 +202,4 @@ or in the chat.
[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
[pycharm-guide]: https://www.jetbrains.com/help/pycharm/2016.3/python-integrated-tools.html