alex/vim-argwrap
1
Fork 0
Code Releases 1 Activity

Updating documentation

Browse Source
This commit is contained in:
Alex Yatskov 2015-01-28 23:15:22 +09:00
parent d674676c7d
commit 7ed22d6602
2 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -19,10 +19,10 @@ information.
`git clone https://github.com/FooSoft/vim-argwrap ~/.vim/bundle/vim-argwrap` `git clone https://github.com/FooSoft/vim-argwrap ~/.vim/bundle/vim-argwrap`
2. Create a keyboard binding for `argwrap#toggle()` inside your `~/.vimrc` file. For example, to declare a normal 2. Create a keyboard binding for the `ArgWrap` command inside your `~/.vimrc` file. For example, to declare a normal
mode mapping, add the following command: mode mapping, add the following command:
`nnoremap <silent> <leader>w :call argwrap#toggle()<CR>` `nnoremap <silent> <leader>a :ArgWrap<CR>`
3. You can customize the wrapping/unwrapping behavior of this extension by setting values for any of the following 3. You can customize the wrapping/unwrapping behavior of this extension by setting values for any of the following
optional global variables in your `.vimrc` file: optional global variables in your `.vimrc` file:
@ -88,7 +88,7 @@ functions identically regardless if it is being applied to a function call, list
Let's begin with a simple function invocation. When there are many arguments being passed to the function, we often wish Let's begin with a simple function invocation. When there are many arguments being passed to the function, we often wish
to wrap them to improve code readability. If you position your cursor anywhere between the parenthesis and execute the to wrap them to improve code readability. If you position your cursor anywhere between the parenthesis and execute the
`argwrap#toggle()` command, the argument list will be wrapped to one per line. `ArgWrap` command, the argument list will be wrapped to one per line.
``` ```
Foo(wibble, wobble, wubble) Foo(wibble, wobble, wubble)

7
doc/argwrap.txt
View File

@ -30,10 +30,10 @@ INSTALLATION *argwrap-installation*
git clone https://github.com/FooSoft/vim-argwrap ~/.vim/bundle/vim-argwrap git clone https://github.com/FooSoft/vim-argwrap ~/.vim/bundle/vim-argwrap
2. Create a keyboard binding for argwrap#toggle() inside your ~/.vimrc file. 2. Create a keyboard binding for the ArgWrap command inside your ~/.vimrc file.
For example, to declare a normal mode mapping, add the following command: For example, to declare a normal mode mapping, add the following command:
nnoremap <silent> <leader>w :call argwrap#toggle()<CR> nnoremap <silent> <leader>a :ArgWrap<CR>
3. You can customize the wrapping/unwrapping behavior of this extension by 3. You can customize the wrapping/unwrapping behavior of this extension by
setting values for any of the following optional global variables in your setting values for any of the following optional global variables in your
@ -95,8 +95,7 @@ being applied to a function call, list or dictionary definition.
Let's begin with a simple function invocation. When there are many arguments Let's begin with a simple function invocation. When there are many arguments
being passed to the function, we often wish to wrap them to improve code being passed to the function, we often wish to wrap them to improve code
readability. If you position your cursor anywhere between the parenthesis and readability. If you position your cursor anywhere between the parenthesis and
execute the argwrap#toggle() command, the argument list will be wrapped to one execute the ArgWrap command, the argument list will be wrapped to one per line.
per line.
Foo(wibble, wobble, wubble) Foo(wibble, wobble, wubble)