X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/10228215c76da4004b5ac4b60cfdf94682ea6e22..19c53ee5f8b6e9054d0ee1c295d876ccb96a21f7:/README.rst?ds=sidebyside diff --git a/README.rst b/README.rst index 1e3de55..ada507e 100644 --- a/README.rst +++ b/README.rst @@ -1,8 +1,8 @@ vim-python-pep8-indent ====================== -.. image:: https://travis-ci.org/hynek/vim-python-pep8-indent.png?branch=travis - :target: https://travis-ci.org/hynek/vim-python-pep8-indent +.. image:: https://travis-ci.org/Vimjas/vim-python-pep8-indent.png?branch=master + :target: https://travis-ci.org/Vimjas/vim-python-pep8-indent This small script modifies Vim_’s indentation behavior to comply with PEP8_ and my aesthetic preferences. Most importantly:: @@ -30,7 +30,7 @@ Follow the instructions on installing Pathogen_ and then: .. code-block:: shell-session $ cd ~/.vim/bundle - $ git clone https://github.com/hynek/vim-python-pep8-indent.git + $ git clone https://github.com/Vimjas/vim-python-pep8-indent.git Vundle @@ -40,7 +40,7 @@ Follow the instructions on installing Vundle_ and add the appropriate plugin lin .. code-block:: vim - Plugin 'hynek/vim-python-pep8-indent' + Plugin 'Vimjas/vim-python-pep8-indent' NeoBundle @@ -50,14 +50,14 @@ Follow the instructions on installing NeoBundle_ and add the appropriate NeoBund .. code-block:: vim - NeoBundle 'hynek/vim-python-pep8-indent' + NeoBundle 'Vimjas/vim-python-pep8-indent' Configuration ------------- -python_pep8_indent_multiline_string -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +g:python_pep8_indent_multiline_string +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ You can configure the initial indentation of multiline strings using ``g:python_pep8_indent_multiline_string`` (which can also be set per buffer). This defaults to ``0``, which means that multiline strings are not indented. @@ -74,6 +74,32 @@ With content already, it will be aligned to the opening parenthesis:: Existing indentation (including ``0``) in multiline strings will be kept, so this setting only applies to the indentation of new/empty lines. +g:python_pep8_indent_hang_closing +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Control closing bracket indentation with ``python_pep8_indent_hang_closing``, set globally or per buffer. + +By default (set to ``0``), closing brackets line up with the opening line:: + + my_list = [ + 1, 2, 3, + 4, 5, 6, + ] + result = some_function_that_takes_arguments( + 'a', 'b', 'c', + 'd', 'e', 'f', + ) + +With ``python_pep8_indent_hang_closing = 1``, closing brackets line up with the items:: + + my_list = [ + 1, 2, 3, + 4, 5, 6, + ] + result = some_function_that_takes_arguments( + 'a', 'b', 'c', + 'd', 'e', 'f', + ) Notes -----