]> 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:

Take over maintainership, move it to Vimjas org
[etc/vim.git] / README.rst
index 85e4359d2f72c96ebf3a379b44c2834e2d0cbcbd..3a8bf3c62956813c431f5fafddfcac027cc35bb3 100644 (file)
@@ -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,7 +50,29 @@ 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
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+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