mirror/evennia
3
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-08-18 03:05:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Start add docs again

Browse Source
This commit is contained in:
Griatch
2020-10-08 21:45:18 +02:00
parent b7fc975379
commit d414cc3ccd
61 changed files with 235 additions and 236 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CODING_STYLE.md
View File

@ -101,7 +101,7 @@ def funcname(a, b, c, d=False, **kwargs):
c (list): A list argument.
d (bool, optional): An optional keyword argument.
Kwargs:
Keyword Args:
test (list): A test keyword.
Returns:
@ -165,13 +165,13 @@ Args:
and
```
Kwargs:
Keyword Args:
argname (type): text
```
mean the same thing! Which one is used depends on the function or
method documented, but there are no hard rules; If there is a large
`**kwargs` block in the function, using the `Kwargs:` block may be a
`**kwargs` block in the function, using the `Keyword Args:` block may be a
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.