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

Updating documentation

Browse Source
This commit is contained in:
Alex Yatskov 2014-12-07 11:41:49 +09:00
parent f7c15bb3c6
commit f8584e8964
2 changed files with 24 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,15 +1,20 @@
# vim-argwrap # # argwrap.vim
vim-argwrap is an industrial strength argument wrapping and unwrapping extension for the [Vim](http://www.vim.org/) text argwrap.vim is an industrial strength argument wrapping and unwrapping extension for the [Vim](http://www.vim.org/) text
editor. It can be used for collapsing and expanding everything from function calls to array and dictionary definitions. editor. It can be used for collapsing and expanding everything from function calls to array and dictionary definitions.
The online resources listed below can be accessed to download new versions of this extension and to access other related
information.
* [Homepage](http://foosoft.net/projects/vim-argwrap/)
* [GitHub](https://github.com/FooSoft/vim-argwrap/)
## Installation ## ## Installation ##
1. Clone or otherwise download the latest version of the *vim-argwrap* extension from its 1. Clone or otherwise download the latest version of the *argwrap.vim* extension from its
[GitHub](https://github.com/FooSoft/vim-argwrap) page (the script is also available for download through [GitHub](https://github.com/FooSoft/vim-argwrap) page (the script is also available for download through
[vim.org](http://www.vim.org/scripts/script.php?script_id=5062)). If you are using [vim.org](http://www.vim.org/scripts/script.php?script_id=5062)). If you are using
[pathogen](https://github.com/tpope/vim-pathogen) for plugin management (you should) you can clone the repository [pathogen.vim](https://github.com/tpope/vim-pathogen) for plugin management (you should) you can clone the
directly to your bundle directory: repository directly to your bundle directory:
`git clone https://github.com/FooSoft/vim-argwrap ~/.vim/bundle/vim-argwrap` `git clone https://github.com/FooSoft/vim-argwrap ~/.vim/bundle/vim-argwrap`
@ -32,7 +37,7 @@ editor. It can be used for collapsing and expanding everything from function cal
) )
``` ```
*BX-style* argument wrapping: *Bx-style* argument wrapping:
``` ```
Foo(wibble Foo(wibble
@ -50,7 +55,7 @@ editor. It can be used for collapsing and expanding everything from function cal
## Examples ## ## Examples ##
Below are some examples of common use cases demonstrating the capabilities of vim-argwrap. Note that the extension Below are some examples of common use cases demonstrating the capabilities of argwrap.vim. Note that the extension
functions identically regardless if it is being applied to a function call, list or dictionary definition. functions identically regardless if it is 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 Let's begin with a simple function invocation. When there are many arguments being passed to the function, we often wish

24
doc/argwrap.txt
View File

@ -1,6 +1,6 @@
*argwrap.txt* Wrap and unwrap function arguments, lists and dictionaries in Vim *argwrap.txt* Wrap and unwrap function arguments, lists and dictionaries in Vim
argwrap argwrap.vim
about |argwrap-about| about |argwrap-about|
installation |argwrap-installation| installation |argwrap-installation|
@ -10,11 +10,11 @@ examples |argwrap-examples|
================================================================================ ================================================================================
ABOUT *argwrap-about* ABOUT *argwrap-about*
argwrap is an industrial strength argument wrapping and unwrapping extension for argwrap.vim is an industrial strength argument wrapping and unwrapping extension
the Vim text editor. It can be used for collapsing and expanding everything from for the Vim text editor. It can be used for collapsing and expanding everything
function calls to array and dictionary definitions. The online listed below can from function calls to array and dictionary definitions. The online resources
be accessed to download new versions of this extension and to access other listed below can be accessed to download new versions of this extension and to
information. access other information.
Homepage: http://foosoft.net/projects/vim-argwrap/ Homepage: http://foosoft.net/projects/vim-argwrap/
GitHub: https://github.com/FooSoft/vim-argwrap/ GitHub: https://github.com/FooSoft/vim-argwrap/
@ -24,10 +24,10 @@ INSTALLATION *argwrap-installation*
## Installation ## ## Installation ##
1. Clone or otherwise download the latest version of the argwrap extension from 1. Clone or otherwise download the latest version of the argwrap.vim extension
its GitHub page (the script is also available for download through vim.org. from its GitHub page (the script is also available for download through
If you are using pathogen for plugin management (you should) you can clone vim.org. If you are using pathogen.vim for plugin management (you should)
the repository directly to your bundle directory: you can clone the repository directly to your bundle directory:
git clone https://github.com/FooSoft/vim-argwrap ~/.vim/bundle/vim-argwrap git clone https://github.com/FooSoft/vim-argwrap ~/.vim/bundle/vim-argwrap
@ -69,8 +69,8 @@ USAGE *argwrap-usage*
EXAMPLES *argwrap-examples* EXAMPLES *argwrap-examples*
Below are some examples of common use cases demonstrating the capabilities of Below are some examples of common use cases demonstrating the capabilities of
argwrap. Note that the extension functions identically regardless if it is being argwrap.vim. Note that the extension functions identically regardless if it is
applied to a function call, list or dictionary definition. 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