From 93d1a33400cf0d4e20c0533326a5374cfe302bac Mon Sep 17 00:00:00 2001 From: Alex Yatskov Date: Sat, 31 Mar 2018 14:28:16 -0700 Subject: [PATCH] updating docs --- doc/argwrap.txt | 80 +++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 75 insertions(+), 5 deletions(-) diff --git a/doc/argwrap.txt b/doc/argwrap.txt index 8c65e1a..287679f 100644 --- a/doc/argwrap.txt +++ b/doc/argwrap.txt @@ -100,14 +100,32 @@ file basis using `ftplugin` or `autocmd`. For example, the `argwrap_tail_comma` wubble ) < - Tail comma enabled for square brackets () + Tail comma enabled for square brackets only () > - r = [ + [ + 1, + 2, 3, - 5, - 8, ] < +* argwrap_tail_indent_braces + Specifies if the closing brace should be indented to argument depth. + Tail indent disabled +> + Foo( + wibble, + wobble, + wubble + ) +< + Tail indent enabled for parenthesis () +> + Foo( + wibble, + wobble, + wubble + ) +< * argwrap_wrap_closing_brace Specifies if the closing brace should be wrapped to a new line. Brace wrapping enabled (default) @@ -125,6 +143,42 @@ file basis using `ftplugin` or `autocmd`. For example, the `argwrap_tail_comma` wobble, wubble) < +* argwrap_comma_first + Specifies if the argument comma delimiter should be placed before arguments. + Comma first disabled (default) +> + Foo( + wibble, + wobble, + wubble + ) +< + Comma first enabled () +> + Foo( + wibble + , wobble + , wubble + ) +< +* argwrap_comma_first_indent + Specifies if the first argument should be indented when used in conjunction with `argwrap_comma_first`. + Comma first indent disabled (default) +> + Foo( + wibble + , wobble + , wubble + ) +< + Comma first indent enabled () +> + Foo( + wibble + , wobble + , wubble + ) +< ------------------------------------------------------------------------------------------------------------------------ USAGE *argwrap-usage* @@ -136,4 +190,20 @@ USAGE ------------------------------------------------------------------------------------------------------------------------ LICENSE *argwrap-license* -MIT +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +