X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/8b215aac0192f74b5aeb6ae5a2e1766db2ebecb8..84f35c0a4f3fcb8a816785e02983732c4a1dcc99:/README.rst?ds=sidebyside

diff --git a/README.rst b/README.rst
index 3a8bf3c..77be58c 100644
--- a/README.rst
+++ b/README.rst
@@ -1,8 +1,10 @@
 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
+.. image:: https://circleci.com/gh/Vimjas/vim-python-pep8-indent.svg?style=svg
+  :target: https://circleci.com/gh/Vimjas/vim-python-pep8-indent
+.. image:: https://codecov.io/gh/Vimjas/vim-python-pep8-indent/branch/master/graph/badge.svg
+  :target: https://codecov.io/gh/Vimjas/vim-python-pep8-indent
 
 This small script modifies Vim_’s indentation behavior to comply with PEP8_ and my aesthetic preferences.
 Most importantly::
@@ -21,6 +23,8 @@ and::
 Installation
 ------------
 
+Install the plugin using your favorite plugin manager / method, a few examples
+follow:
 
 Pathogen
 ^^^^^^^^
@@ -56,8 +60,8 @@ Follow the instructions on installing NeoBundle_ and add the appropriate NeoBund
 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 +78,47 @@ 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',
+       )
+
+
+Troubleshooting
+---------------
+
+In case it is not working, please make sure your Vim is configured to load
+indent files (``filetype indent on``).
+This is typically the case when using a plugin manager, but check its docs.
+
+Check ``:verbose set indentexpr?`` in a Python file, which should show
+something like the following:
+
+  indentexpr=GetPythonPEPIndent(v:lnum)
+        Last set from ~/…/plugged/vim-python-pep8-indent/indent/python.vim
+
 
 Notes
 -----