Skip to content

Commit 90a0ab1

Browse files
committed
Align the doc with new implementation
1 parent e372138 commit 90a0ab1

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

doc/pydocstring.txt

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,11 +135,18 @@ If you don't like default docstring, You can modify docstring template.
135135

136136
Template variables.
137137
|{{_header_}}| Class, function or method name as a value.
138-
|{{_args_}}| Assign function or method's arguments.
139-
|{{_lf_}}| Assign line break.
138+
|{{_args_}}| Assign function or method's arguments.
139+
|{{_lf_}}| Assign line break.
140140
|{{_indent_}}| Assign indent.
141141
|{{_nested_indent_}}| Assign indent.
142-
142+
|{{_returnType_}}| Function or method return type.
143+
144+
There's some rules for parsing template:
145+
- `{{_header_}`, `{{_args}}` and `{{_returnType_}}` should be on their own
146+
line.
147+
- Pydocstring will insert a emmpty line between each parts, so you don't
148+
need to include empty line in your template. Please see the default template
149+
directory to have an example.
143150
==============================================================================
144151
VARIABLES *pydocstring-vim-variables*
145152

0 commit comments

Comments
 (0)