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

Tweak of coding style doc

Browse source
This commit is contained in:
Griatch 2022-02-22 23:24:30 +01:00
parent bb1102d181
commit c3e8b7b23d
1 changed files with 10 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

14
CODING_STYLE.md
View file

@ -101,11 +101,11 @@ def funcname(a, b, c, d=False, **kwargs):
c (list): A list argument. c (list): A list argument.
d (bool, optional): An optional keyword argument. d (bool, optional): An optional keyword argument.
Kwargs: Keyword Args:
test (list): A test keyword. test (list): A test keyword.
Returns: Returns:
e (str): The result of the function. str: The result of the function.
Raises: Raises:
RuntimeException: If there is a critical error, RuntimeException: If there is a critical error,
@ -129,18 +129,12 @@ indents to be 4 spaces wide (no tabs!).
Here are all the supported block headers: Here are all the supported block headers:
``` ```
Args/Arg/Kwargs/Kwarg: Args/Keyword Args:
argname (freeform type): text argname (freeform type): text
or
freeform text
Returns/Yields: Returns/Yields:
kwargname (freeform type): text type: text
or
freeform text
Raises: Raises:
Exceptiontype: text Exceptiontype: text
or
freeform text
Notes/Note/Examples/Example: Notes/Note/Examples/Example:
freeform text freeform text
``` ```