X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/eb527d01d53257088da8c215b5d909623d543fad..10228215c76da4004b5ac4b60cfdf94682ea6e22:/README.rst

diff --git a/README.rst b/README.rst
index 85e4359..1e3de55 100644
--- a/README.rst
+++ b/README.rst
@@ -53,6 +53,28 @@ Follow the instructions on installing NeoBundle_ and add the appropriate NeoBund
    NeoBundle 'hynek/vim-python-pep8-indent'
 
 
+Configuration
+-------------
+
+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.
+``-1`` and positive values will be used as-is, where ``-1`` is a special value for Vim's ``indentexpr``, and will keep the existing indent (using Vim's ``autoindent`` setting).
+``-2`` is meant to be used for strings that are wrapped with ``textwrap.dedent`` etc.  It will add a level of indentation if the multiline string started in the previous line, without any content in it already::
+
+   testdir.makeconftest("""
+       _
+
+With content already, it will be aligned to the opening parenthesis::
+
+   testdir.makeconftest("""def pytest_addoption(parser):
+                        _
+
+Existing indentation (including ``0``) in multiline strings will be kept, so this setting only applies to the indentation of new/empty lines.
+
+
 Notes
 -----
 
@@ -99,4 +121,4 @@ This mainly means that I’ll triage through bugs and pull requests but won’t
 .. _me: https://hynek.me/
 .. _CC0: http://creativecommons.org/publicdomain/zero/1.0/
 .. _contributed: https://github.com/hynek/vim-python-pep8-indent/blob/master/CONTRIBUTING.rst
-.. _`generous people`: https://github.com/hynek/vim-python-pep8-indent/blob/master/AUTHORS.rst
+.. _`generous people`: https://github.com/hynek/vim-python-pep8-indent/graphs/contributors