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

Another clarification

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

4
CODING_STYLE.md
View file

@ -30,13 +30,15 @@ on your sources.
## Doc strings ## Doc strings
All modules, classes, functions and methods should have docstrings All modules, classes, functions and methods should have docstrings
formatted with [Google style][googlestyle] indents, using formatted with [Google style][googlestyle] -inspired indents, using
[Markdown][githubmarkdown] formatting where needed. Evennia's `api2md` [Markdown][githubmarkdown] formatting where needed. Evennia's `api2md`
parser will use this to create pretty API documentation. parser will use this to create pretty API documentation.
> Note that far from all sources are currently formatted using the > Note that far from all sources are currently formatted using the
> consistent style listed here. This is something that is being > consistent style listed here. This is something that is being
> worked on and any help to convert existing docs are appreciated. > worked on and any help to convert existing docs are appreciated.
> We also don't support all forms of the google style syntax, going
> for a limited and more restricted set for consistency.
### Module docstrings ### Module docstrings