Merge branch 'nfischer-add-disable-mapping-option'

Author: heavenshell

CHANGES.rst

@@ -1,3 +1,10 @@
+Version 0.0.6
+-------------
+Released on January 17th 2016
+
+- add ``pydocstring_enable_mapping`` option.
+  Thx @nfischer
+
 Version 0.0.5
 -------------
 Released on September 28th 2015

autoload/pydocstring.vim

@@ -1,6 +1,6 @@
 " Insert Docstring.
 " Author:      Shinya Ohyanagi <sohyanagi@gmail.com>
-" Version:     0.0.5
+" Version:     0.0.6
 " License:     This file is placed in the public domain.
 " WebPage:     http://github.com/heavenshell/vim-pydocstriong/
 " Description: Generate Python docstring to your Python script file.

doc/pydocstring.txt

@@ -1,6 +1,6 @@
 *pydocstring.txt*	Generate Python docstring to your Python code.
 
-Version: 0.0.5
+Version: 0.0.6
 Author: Shinya Ohynagi <sohyanagi@gmail.com>
 Repository: http://github.com/heavenshell/vim-pydocstring/
 License: BSD, see LICENSE for more details.
@@ -161,6 +161,16 @@ g:pydocstring_enable_comment			*g:pydocstring_enable_comment*
 
 		Default value is '1'
 
+g:pydocstring_enable_mapping			*g:pydocstring_enable_mapping*
+		Disable this option to prevent pydocstring from creating any
+		key mapping to the `:Pydocstring` command.
+		Note: this value is overridden if you explicitly create a
+		mapping in your vimrc, such as if you do:
+
+    nmap <silent> <C-m> <Plug>(pydocstring)
+
+		Default value is '1'
+
 ==============================================================================
 EXAMPLE						*pydocstring-vim-example*
 
@@ -196,6 +206,10 @@ Override default mapping.
 
     nmap <silent> <C-m> <Plug>(pydocstring)
 
+  To disable mappings entirely, add the following to your .vimrc or _vimrc.
+
+    let g:pydocstring_enable_mapping = 0
+
 
 ==============================================================================
 vim:tw=78:ts=8:ft=help:norl:noet:fen:fdl=0:

ftplugin/python/pydocstring.vim

@@ -1,6 +1,6 @@
 " File:     pydocstring.vim
 " Author:   Shinya Ohyanagi <sohyanagi@gmail.com>
-" Version:  0.0.5
+" Version:  0.0.6
 " WebPage:  http://github.com/heavenshell/vim-pydocstriong/
 " Description: Generate Python docstring to your Python script file.
 " License: BSD, see LICENSE for more details.
@@ -10,9 +10,15 @@ set cpo&vim
 
 command! -nargs=0 -buffer -complete=customlist,pydocstring#insert Pydocstring call pydocstring#insert()
 
-nnoremap <silent> <buffer> <Plug>(pydocstring) :call pydocstring#insert()<CR>
-if !hasmapto('<Plug>(pydocstring)')
-  nmap <silent> <C-l> <Plug>(pydocstring)
+if !exists('g:pydocstring_enable_mapping')
+  let g:pydocstring_enable_mapping = 1
+endif
+
+if g:pydocstring_enable_mapping == 1 || hasmapto('<Plug>(pydocstring)')
+  nnoremap <silent> <buffer> <Plug>(pydocstring) :call pydocstring#insert()<CR>
+  if !hasmapto('<Plug>(pydocstring)')
+    nmap <silent> <C-l> <Plug>(pydocstring)
+  endif
 endif
 
 let &cpo = s:save_cpo