Merge pull request #21 from heavenshell/fix/issue_19

Fix/issue 19

Author: heavenshell

CHANGES.rst

@@ -1,3 +1,13 @@
+Version 0.1.2
+-------------
+Released on Mar 25th 2017
+
+- Fix bug
+  Ignored indent when docstring start with `'''`.
+  Delete blank line if `{{_returnType_}}` not exists.
+  see https://github.com/heavenshell/vim-pydocstring/issues/19
+  Thx @brainscience
+
 Version 0.1.1
 -------------
 Released on Feb 12th 2017

autoload/pydocstring.vim

@@ -1,7 +1,6 @@
 " Insert Docstring.
 " Author:      Shinya Ohyanagi <[email protected]>
-" Version:     0.1.1
-" License:     This file is placed in the public domain.
+" Version:     0.1.2
 " WebPage:     http://github.com/heavenshell/vim-pydocstriong/
 " Description: Generate Python docstring to your Python script file.
 " License:     BSD, see LICENSE for more details.
@@ -61,7 +60,7 @@ function! s:parseFunc(type, line)
 
   let arrowIndex = match(a:line, "->")
   if arrowIndex != -1
-    let substring = strpart(a:line, arrowIndex+2)
+    let substring = strpart(a:line, arrowIndex + 2)
     let returnType = substitute(substring, '\W*', '', 'g')
   else
     let returnType = ''
@@ -150,11 +149,15 @@ function! s:builddocstring(strs, indent, nested_indent)
   let tmpl = ''
   let docstrings = []
   let lines = s:readtmpl('multi')
+  let has_return_type = 0
+  if match(lines, '\c{{_returnType_}}') != -1
+    let has_return_type = 1
+  endif
   for line in lines
     if line =~ '{{_header_}}'
       let header = substitute(line, '{{_header_}}', prefix, '')
       call add(docstrings, a:indent . header)
-      call add(docstrings, '' )
+      call add(docstrings, '')
     elseif line =~ '{{_args_}}'
       if len(args) != 0
         for arg in args
@@ -194,7 +197,9 @@ function! s:builddocstring(strs, indent, nested_indent)
           let template = substitute(template, '{{_nested_indent_}}', a:nested_indent, 'g')
           call add(docstrings, a:indent . template)
         endfor
-        call add(docstrings, '')
+        if has_return_type == 1
+          call add(docstrings, '')
+        endif
       endif
     elseif line =~ '{{_indent_}}'
       let arg = substitute(line, '{{_indent_}}', a:indent, 'g')
@@ -206,7 +211,7 @@ function! s:builddocstring(strs, indent, nested_indent)
       else
         call remove(docstrings, -1)
       endif
-    elseif line == '"""'
+    elseif line == '"""' || line == "'''"
       call add(docstrings, a:indent . line)
     else
       call add(docstrings, line)

doc/pydocstring.txt

@@ -1,6 +1,6 @@
 *pydocstring.txt*	Generate Python docstring to your Python code.
 
-Version: 0.1.1
+Version: 0.1.2
 Author: Shinya Ohynagi <[email protected]>
 Repository: http://github.com/heavenshell/vim-pydocstring/
 License: BSD, see LICENSE for more details.

ftplugin/python/pydocstring.vim

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

test/custom-template.vader

@@ -1,7 +1,7 @@
 # vim:set et sw=4 ts=4 tw=79:
 Execute (Setup template dir):
     Save g:pydocstring_templates_dir
-    let g:pydocstring_templates_dir = './test-template/'
+    let g:pydocstring_templates_dir = './templates/custom-templates/'
 
 Given python (def foo):
     def foo():

test/issue19.vader

@@ -0,0 +1,43 @@
+# vim:set et sw=4 ts=4 tw=79:
+Execute (Setup template dir):
+    Save g:pydocstring_templates_dir
+    let g:pydocstring_templates_dir = './templates/issue19/'
+
+Given python (def foo with 1 params):
+    def foo(arg1):
+        pass
+
+Execute:
+    Pydocstring
+
+Expect python:
+    def foo(arg1):
+        '''
+        foo
+
+        Args:
+            arg1:
+        '''
+        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:
+        '''
+        pass
+
+Execute (Clear pydocstring_templates_dir):
+    Restore