]> git.madduck.net Git - etc/vim.git/blobdiff - README.rst

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Improve handling of multiline strings (#50)
[etc/vim.git] / README.rst
index 719531547798bc4010315c458a633170fae49413..1e3de55b91b5d34855a7567e58e16fe35b910bce 100644 (file)
@@ -4,11 +4,11 @@ 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
 
-This small script modifies vim_’s indentation behavior to comply with PEP8_ and my aesthetic preferences.
+This small script modifies Vim_’s indentation behavior to comply with PEP8_ and my aesthetic preferences.
 Most importantly::
 
    foobar(foo,
-         bar)
+          bar)
 
 and::
 
@@ -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
 -----
 
@@ -67,13 +89,13 @@ Therefore, if you want to use this version specifically, you’ll have to disabl
 License and Authorship
 ----------------------
 
-This script is based on one from vim’s official `script repo`_  that was *not* originally written by me.
+This script is based on one from Vim’s official `script repo`_  that was *not* originally written by me.
 Unfortunately the indentation was off by one character in one case and the script hasn’t been updated since 2005.
 
 Even more unfortunately, I wasn’t able to reach any of the original authors/maintainers:
 **David Bustos** and **Eric Mc Sween**.
 
-So I fixed the annoyance it with the help of `Steve Losh`_ and am putting it out here so you don’t have to patch the original yourself.
+So I fixed the annoyance with the help of `Steve Losh`_ and am putting it out here so you don’t have to patch the original yourself.
 The original patch is still available here_.
 
 Over the time a lot more improvements have been contributed_ by `generous people`_.
@@ -86,7 +108,7 @@ While my Vimscript_ skills are still feeble, I intend to maintain it for now.
 This mainly means that I’ll triage through bugs and pull requests but won’t be fixing much myself.
 
 
-.. _vim: http://www.vim.org/
+.. _Vim: http://www.vim.org/
 .. _PEP8: http://www.python.org/dev/peps/pep-0008/
 .. _`script repo`: http://www.vim.org/scripts/script.php?script_id=974
 .. _`Steve Losh`: http://stevelosh.com/
@@ -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