From c5de0769d8c00817d42ed6f1b2e7ea4cca2cbc8d Mon Sep 17 00:00:00 2001 From: Alex Yatskov Date: Wed, 15 Dec 2021 18:05:19 -0800 Subject: [PATCH] Update README --- README.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 43fcede..6f509ad 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,9 @@ Collection = "ProjectsActive" # Vim-ArgWrap -ArgWrap is an industrial strength argument wrapping and unwrapping extension for the Vim text editor. It can be used for -collapsing and expanding everything from function calls to array and dictionary definitions. All operations are easily -reversible and correctly preserve the indentation of the surrounding code. +Vim-ArgWrap is an industrial strength argument wrapping and unwrapping extension for the Vim text editor. It can be used +for collapsing and expanding everything from function calls to array and dictionary definitions. All operations are +easily reversible and correctly preserve the indentation of the surrounding code. ![](img/demo.gif) @@ -24,8 +24,7 @@ reversible and correctly preserve the indentation of the surrounding code. $ git clone https://github.com/FooSoft/vim-argwrap ~/.vim/bundle/vim-argwrap ``` -2. Create a keyboard binding for the `ArgWrap` command 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: ``` @@ -40,7 +39,7 @@ global variables (prefixed with `g:`), making them ideal for configuring the beh file basis using `ftplugin` or `autocmd`. For example, the `argwrap_tail_comma` variable has two variants declared as `b:argwrap_tail_comma` and `g:argwrap_tail_comma`, for buffer and global scopes respectively. -* **argwrap\_line\_prefix** +* `argwrap_line_prefix` Specifies a line prefix to be added and removed when working with languages that require newlines to be escaped. @@ -64,7 +63,7 @@ file basis using `ftplugin` or `autocmd`. For example, the `argwrap_tail_comma` \) ``` -* **argwrap\_padded\_braces** +* `argwrap_padded_braces` Specifies which brace types should be padded on the inside with spaces. @@ -84,7 +83,7 @@ file basis using `ftplugin` or `autocmd`. For example, the `argwrap_tail_comma` *Padding can be specified for multiple brace types (`let g:argwrap_padded_braces = '[{'`)* -* **argwrap\_tail\_comma** +* `argwrap_tail_comma` Specifies if any closing brace should be preceded with a comma when wrapping lines. @@ -108,7 +107,7 @@ file basis using `ftplugin` or `autocmd`. For example, the `argwrap_tail_comma` ) ``` -* **argwrap\_tail\_comma\_braces** +* `argwrap_tail_comma_braces` Specifies which closing brace should be preceded with a comma when wrapping lines. @@ -132,7 +131,7 @@ file basis using `ftplugin` or `autocmd`. For example, the `argwrap_tail_comma` ] ``` -* **argwrap\_tail\_indent\_braces** +* `argwrap_tail_indent_braces` Specifies if the closing brace should be indented to argument depth. @@ -156,7 +155,7 @@ file basis using `ftplugin` or `autocmd`. For example, the `argwrap_tail_comma` ) ``` -* **argwrap\_wrap\_closing\_brace** +* `argwrap_wrap_closing_brace` Specifies if the closing brace should be wrapped to a new line. @@ -179,7 +178,7 @@ file basis using `ftplugin` or `autocmd`. For example, the `argwrap_tail_comma` wubble) ``` -* **argwrap\_comma\_first** +* `argwrap_comma_first` Specifies if the argument comma delimiter should be placed before arguments. @@ -203,7 +202,7 @@ file basis using `ftplugin` or `autocmd`. For example, the `argwrap_tail_comma` ) ``` -* **argwrap\_comma\_first\_indent** +* `argwrap_comma_first_indent` Specifies if the first argument should be indented when used in conjunction with `argwrap_comma_first`.