From 7ed22d66026e3408c51848f2036481cef4153d1f Mon Sep 17 00:00:00 2001 From: Alex Yatskov Date: Wed, 28 Jan 2015 23:15:22 +0900 Subject: [PATCH] Updating documentation --- README.md | 6 +++--- doc/argwrap.txt | 7 +++---- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3dcd0a7..e56f7a3 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,10 @@ information. `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: - `nnoremap w :call argwrap#toggle()` + `nnoremap a :ArgWrap` 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: @@ -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 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) diff --git a/doc/argwrap.txt b/doc/argwrap.txt index 40a5af8..5743c10 100644 --- a/doc/argwrap.txt +++ b/doc/argwrap.txt @@ -30,10 +30,10 @@ INSTALLATION *argwrap-installation* 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: - nnoremap w :call argwrap#toggle() + nnoremap a :ArgWrap 3. You can customize the wrapping/unwrapping behavior of this extension by 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 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 argwrap#toggle() command, the argument list will be wrapped to one -per line. +execute the ArgWrap command, the argument list will be wrapped to one per line. Foo(wibble, wobble, wubble)