From d48f85645f64cd80978c4fff3d7a0d576a490cd1 Mon Sep 17 00:00:00 2001
From: Alex Yatskov <alex@foosoft.net>
Date: Sat, 6 Dec 2014 19:18:50 +0900
Subject: [PATCH] Updating vim-argwrap documentation

---
 README.md | 103 ++++++++++++++++++++++++++++++++++--------------------
 1 file changed, 65 insertions(+), 38 deletions(-)

diff --git a/README.md b/README.md
index 78eebdc..7f20d47 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,15 @@
-## vim-argwrap ##
+# vim-argwrap #
 
-This is an industrial strength argument wrapping and unwrapping extension for the [Vim](http://www.vim.org/) text
+vim-argwrap 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.
 
-### Installation and Usage ###
+## Installation ##
 
-1.  Clone or otherwise download the *vim-argwrap* extension from [GitHub](https://github.com/FooSoft/vim-argwrap).  If
-    you are using [pathogen](https://github.com/tpope/vim-pathogen) for plugin management (you should) you can clone the
-    repository directly to your bundle directory:
+1.  Clone or otherwise download the latest version of the *vim-argwrap* extension from its
+    [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
+    [pathogen](https://github.com/tpope/vim-pathogen) for plugin management (you should) you can clone the repository
+    directly to your bundle directory:
 
     `git clone https://github.com/FooSoft/vim-argwrap ~/.vim/bundle/vim-argwrap`
 
@@ -16,22 +18,47 @@ editor. It can be used for collapsing and expanding everything from function cal
 
     `nnoremap <silent> <leader>w :call argwrap#toggle()<CR>`
 
-3.  Position the cursor *inside* of the scope of the parenthesis, brackets or curly braces you wish to wrap/unwrap (not
-    on top or before or after them).
+    The `toggle` function receives an optional style argument, which may be either `"default"` or `"bx"`. Not providing
+    an explicit value is equivalent to specifying the `"default"` setting. The style determines the wrapping behavior
+    as seen below:
 
-4.  Execute the keyboard binding you defined above to *toggle* the wrapping and unwrapping of arguments.
+    *Default-style* argument wrapping:
 
-### Examples ###
+    ```
+    Foo(
+        wibble,
+        wobble,
+        wubble
+    )
+    ```
+
+    *BX-style* argument wrapping:
+
+    ```
+    Foo(wibble
+        , wobble
+        , wubble
+        )
+    ```
+
+## Usage ##
+
+1.  Position the cursor *inside* of the scope of the parenthesis, brackets or curly braces you wish to wrap/unwrap (not
+    on top, before or after them).
+
+2.  Execute the keyboard binding you defined above to *toggle* the wrapping and unwrapping of arguments.
+
+## Examples ##
 
 Below are some examples of common use cases demonstrating the capabilities of vim-argwrap. Note that the extension
-functions identically regardless if it is being used on a function call, list or dictionary definitions.
+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
 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.
 
 ```
-Foo('wibble', 'wobble', 'wubble')
+Foo(wibble, wobble, wubble)
 
 ```
 
@@ -39,9 +66,9 @@ Becomes this:
 
 ```
 Foo(
-    'wibble',
-    'wobble',
-    'wubble'
+    wibble,
+    wobble,
+    wubble
 )
 
 ```
@@ -49,42 +76,42 @@ Foo(
 List definitions work in a similar fashion:
 
 ```
-foo = ['bar', 'baz', 'qux', 'quux', 'corge']
+foo = [bar, baz, qux, quux, corge]
 ```
 
 Becomes this:
 
 ```
 foo = [
-    'bar',
-    'baz',
-    'qux',
-    'quux',
-    'corge'
+    bar,
+    baz,
+    qux,
+    quux,
+    corge
 ]
 ```
 
-Dictionaries work just fine too:
+Dictionaries also work the way you expected them to:
 
 ```
-foo = {'bar': 1, 'baz': 3, 'qux': 3, 'quux': 7}
+foo = {bar: 1, baz: 3, qux: 3, quux: 7}
 ```
 
 Becomes this:
 
 ```
 foo = {
-    'bar': 1,
-    'baz': 3,
-    'qux': 3,
-    'quux': 7
+    bar: 1,
+    baz: 3,
+    qux: 3,
+    quux: 7
 }
 ```
 
 Finally, nested combinations of all the above are also supported:
 
 ```
-Foo(['wibble', 'wobble', 'wubble'], 'spam', {'bar': 'baz', qux: [1, 3, 3, 7]})
+Foo([wibble, wobble, wubble], spam, {bar: baz, qux: [1, 3, 3, 7]})
 ```
 
 Becomes this:
@@ -92,28 +119,28 @@ Becomes this:
 
 ```
 Foo(
-    ['wibble', 'wobble', 'wubble'],
-    'spam',
-    {'bar': 'baz', 'qux': [1, 3, 3, 7]}
+    [wibble, wobble, wubble],
+    spam,
+    {bar: baz, qux: [1, 3, 3, 7]}
 )
 
 ```
 
-You can continue expanding to:
+You can continue argument expansion to:
 
 
 ```
 
 Foo(
     [
-        'wibble',
-        'wobble',
-        'wubble'
+        wibble,
+        wobble,
+        wubble
     ],
-    'spam',
+    spam,
     {
-        'bar': 'baz',
-        'qux': [
+        bar: baz,
+        qux: [
             1,
             3,
             3,