Tweak of coding style doc
This commit is contained in:
parent
bb1102d181
commit
c3e8b7b23d
1 changed files with 10 additions and 16 deletions
|
|
@ -101,11 +101,11 @@ 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:
|
||||
e (str): The result of the function.
|
||||
str: The result of the function.
|
||||
|
||||
Raises:
|
||||
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:
|
||||
|
||||
```
|
||||
Args/Arg/Kwargs/Kwarg:
|
||||
Args/Keyword Args:
|
||||
argname (freeform type): text
|
||||
or
|
||||
freeform text
|
||||
Returns/Yields:
|
||||
kwargname (freeform type): text
|
||||
or
|
||||
freeform text
|
||||
type: text
|
||||
Raises:
|
||||
Exceptiontype: text
|
||||
or
|
||||
freeform text
|
||||
Notes/Note/Examples/Example:
|
||||
freeform text
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue