Fix remove blank line above {{_return_type_}} (#39)

* Fix remove blank line above {{_return_type_}}

* Fix travis settings

* Fix configure settings

* Fix disable gui

Author: heavenshell

.travis.yml

@@ -1,3 +1,5 @@
+sudo: false
+dist: trusty
 language: vim
 
 install:
@@ -7,7 +9,7 @@ install:
   - mkdir ~/tmp
   - cd /tmp/vim
   - sudo apt-get install -y gettext libncurses5-dev libacl1-dev libgpm-dev
-  - ./configure --with-features=huge --enable-fail-if-missing --enable-pythoninterp --prefix=$HOME/tmp/vim
+  - ./configure --with-features=huge --enable-fail-if-missing --enable-pythoninterp --prefix=$HOME/tmp/vim --disable-gui
   - make && make install
   - git clone https://github.com/junegunn/vader.vim.git
   - export VIM_EXE=$HOME/tmp/vim/bin/vim

CHANGES.rst

@@ -1,7 +1,16 @@
-Version 0.1.6
+Version 0.2.0
 -------------
 Released on Nov 19th 2017
 
+- Minor changes
+
+  - Notice template `{{_return_type_}}` does not add extra blank
+  - Now template shows as is
+
+Version 0.1.6
+-------------
+Released on Nov 18th 2017
+
 - Minor changes
 
   - Change function name camelCase to snake_case

autoload/pydocstring.vim

@@ -1,6 +1,6 @@
 " Insert Docstring.
 " Author:      Shinya Ohyanagi <sohyanagi@gmail.com>
-" Version:     0.1.6
+" Version:     0.2.0
 " WebPage:     http://github.com/heavenshell/vim-pydocstriong/
 " Description: Generate Python docstring to your Python script file.
 " License:     BSD, see LICENSE for more details.
@@ -149,10 +149,6 @@ 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_}}\|\c{{_return_type_}}') != -1
-    let has_return_type = 1
-  endif
   for line in lines
     if line =~ '{{_header_}}'
       let header = substitute(line, '{{_header_}}', prefix, '')
@@ -167,10 +163,10 @@ function! s:builddocstring(strs, indent, nested_indent)
           let template = line
           let typed = 0
           if match(arg, ':') != -1
-            let argTemplate = join(s:readtmpl('arg'), '')
-            let argParts = split(arg, ':')
-            let argTemplate = substitute(argTemplate, '{{_name_}}', argParts[0], 'g')
-            let arg = substitute(argTemplate, '{{_type_}}', argParts[1], 'g')
+            let arg_template = join(s:readtmpl('arg'), '')
+            let arg_parts = split(arg, ':')
+            let arg_template = substitute(arg_template, '{{_name_}}', arg_parts[0], 'g')
+            let arg = substitute(arg_template, '{{_type_}}', arg_parts[1], 'g')
             let typed = 1
           endif
           let template = substitute(template, '{{_args_}}', arg, 'g')
@@ -196,9 +192,6 @@ function! s:builddocstring(strs, indent, nested_indent)
           let template = substitute(template, '\s$', '', '')
           call add(docstrings, a:indent . template)
         endfor
-        if has_return_type == 1
-          call add(docstrings, '')
-        endif
       endif
     elseif line =~ '{{_indent_}}'
       let arg = substitute(line, '{{_indent_}}', a:indent, 'g')
@@ -208,7 +201,9 @@ function! s:builddocstring(strs, indent, nested_indent)
         let rt = substitute(line, '{{_returnType_}}\|{{_return_type_}}', return_type, '')
         call add(docstrings, a:indent . rt)
       else
-        call remove(docstrings, -1)
+        if docstrings[-1] == ''
+          call remove(docstrings, -1)
+        endif
       endif
     elseif line == '"""' || line == "'''"
       call add(docstrings, a:indent . line)

doc/pydocstring.txt

@@ -1,6 +1,6 @@
 *pydocstring.txt*	Generate Python docstring to your Python code.
 
-Version: 0.1.6
+Version: 0.2.0
 Author: Shinya Ohynagi <sohyanagi@gmail.com>
 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 <sohyanagi@gmail.com>
-" Version:  0.1.6
+" Version:  0.2.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/basic.vader

@@ -208,7 +208,6 @@ Expect python:
       :type weights: tuple
       :param coords:
       :type coords: numpy.ndarray
-
       :rtype: numpy.ndarray
       """
       pass

test/issue_return_type.vader

@@ -30,7 +30,6 @@ Expect python:
         """foo
 
         :param sample_var:
-
         :rtype: str
         """
         pass
@@ -47,7 +46,6 @@ Expect python:
 
         :param arg1:
         :param arg2:
-
         :rtype: str
         """
         pass
@@ -65,7 +63,6 @@ Expect python:
 
         :param n:
         :type n: int
-
         :rtype: int
         """
         pass
@@ -85,7 +82,6 @@ Expect python:
         :type n: int
         :param m:
         :type m: str
-
         :rtype: int
         """
         pass
@@ -105,7 +101,6 @@ Expect python:
         :param n:
         :type n: int
         :param arg:
-
         :rtype: int
         """
         pass

test/templates/custom-templates/multi.txt

@@ -1,5 +1,6 @@
 """{{_header_}}
 
 {{_args_}}:{{_lf_}}{{_indent_}}    the ...
+
 return ({{_return_type_}}):
 """

test/templates/numpy/multi.txt

@@ -4,6 +4,7 @@
 {{_indent_}}----------
 
 {{_args_}} :
+
 {{_indent_}}Returns
 {{_indent_}}-------
 

test/type-hint.vader

@@ -26,7 +26,6 @@ Expect python:
         """foo
 
         :param sample_var:
-
         :rtype: str
         """
         pass
@@ -43,7 +42,6 @@ Expect python:
 
         :param arg1:
         :param arg2:
-
         :rtype: str
         """
         pass
@@ -61,7 +59,6 @@ Expect python:
 
         :param n:
         :type n: int
-
         :rtype: int
         """
         pass
@@ -81,7 +78,6 @@ Expect python:
         :type n: int
         :param m:
         :type m: str
-
         :rtype: int
         """
         pass
@@ -101,7 +97,6 @@ Expect python:
         :param n:
         :type n: int
         :param arg:
-
         :rtype: int
         """
         pass