Merge remote-tracking branch 'origin/master'

Author: heavenshell

CHANGES.rst

@@ -1,3 +1,15 @@
+Version 0.6.0
+-------------
+Released on Jun 30th 2018
+
+- Bug fix
+
+  - indent doesn't work with `{{_return_type_}}` or `{{_nested_indent_}}`
+
+  see https://github.com/heavenshell/vim-pydocstring/issues/51
+
+  Thx @JPFrancoia
+
 Version 0.5.0
 -------------
 Released on Jun 30th 2018

autoload/pydocstring.vim

@@ -1,6 +1,6 @@
 " Insert Docstring.
 " Author:      Shinya Ohyanagi <sohyanagi@gmail.com>
-" Version:     0.5.0
+" Version:     0.6.0
 " WebPage:     http://github.com/heavenshell/vim-pydocstriong/
 " Description: Generate Python docstring to your Python script file.
 " License:     BSD, see LICENSE for more details.
@@ -308,18 +308,20 @@ function! s:build_docstring(strs, indent, nested_indent)
           call add(docstrings, a:indent . template)
         endfor
       endif
-    elseif line =~ '{{_indent_}}'
-      let arg = substitute(line, '{{_indent_}}', a:indent, 'g')
-      call add(docstrings, arg)
-    elseif line =~ '{{_returnType_}}\|{{_return_type_}}'
+    elseif match(line, '{{_returnType_}}\|{{_return_type_}}') != -1
       if strlen(return_type) != 0
+        let line = substitute(line, '{{_indent_}}', a:indent, 'g')
+        let line = substitute(line, '{{_nested_indent_}}', a:nested_indent, 'g')
         let rt = substitute(line, '{{_returnType_}}\|{{_return_type_}}', return_type, '')
         call add(docstrings, a:indent . rt)
       else
         if docstrings[-1] == ''
           call remove(docstrings, -1)
         endif
       endif
+    elseif line =~ '{{_indent_}}'
+      let arg = substitute(line, '{{_indent_}}', a:indent, 'g')
+      call add(docstrings, arg)
     elseif line == '"""' || line == "'''"
       call add(docstrings, a:indent . line)
     else

ftplugin/python/pydocstring.vim

@@ -1,6 +1,6 @@
 " File:     pydocstring.vim
 " Author:   Shinya Ohyanagi <sohyanagi@gmail.com>
-" Version:  0.5.0
+" Version:  0.6.0
 " WebPage:  http://github.com/heavenshell/vim-pydocstriong/
 " Description: Generate Python docstring to your Python script file.
 " License: BSD, see LICENSE for more details.

test/issue_return_type_indent.vader

@@ -0,0 +1,67 @@
+# vim:set et sw=4 ts=4 tw=79:
+Execute (Setup template dir):
+    Save g:pydocstring_templates_dir
+    let g:pydocstring_templates_dir = './templates/issue51/'
+
+Given python (def foo with 1 params):
+    def foo(arg1):
+        pass
+
+Execute:
+    Pydocstring
+
+Expect python:
+    def foo(arg1):
+        """foo
+
+        Args:
+            arg1:
+
+        Returns:
+        """
+        pass
+
+
+Given python (def foo with 2 params):
+    def foo(arg1, arg2):
+        pass
+
+Execute:
+    Pydocstring
+
+Expect python:
+    def foo(arg1, arg2):
+        """foo
+
+        Args:
+            arg1:
+            arg2:
+
+        Returns:
+        """
+        pass
+
+
+Given python (return type):
+    def foo(arg1: str, arg2: int) -> bool:
+        pass
+
+Execute:
+    Pydocstring
+
+Expect python:
+    def foo(arg1: str, arg2: int) -> bool:
+        """foo
+
+        Args:
+            arg1 (str):
+            arg2 (int):
+
+        Returns:
+            bool
+        """
+        pass
+
+
+Execute (Clear pydocstring_templates_dir):
+    Restore

test/templates/issue51/arg.txt

@@ -0,0 +1 @@
+{{_name_}} ({{_type_}}):

test/templates/issue51/comment.txt

@@ -0,0 +1 @@
+# 

test/templates/issue51/multi.txt

@@ -0,0 +1,8 @@
+"""{{_header_}}
+
+{{_indent_}}Args:
+{{_nested_indent_}}{{_args_}}:
+
+{{_indent_}}Returns:
+{{_nested_indent_}}{{_return_type_}}
+"""

test/templates/issue51/oneline.txt

@@ -0,0 +1 @@
+"""{{_header_}}"""