From: Hynek Schlawack Date: Mon, 8 Sep 2014 10:39:09 +0000 (+0200) Subject: Merge branch 'pr/34' X-Git-Url: https://git.madduck.net/etc/vim.git/commitdiff_plain/5eda24245afc08e35968d23321d9d6d4fac67225?hp=47ab0458c0c8f005777b92fccd4008d26bd0d0af Merge branch 'pr/34' Fixes #25 Fixes #34 --- diff --git a/AUTHORS.rst b/AUTHORS.rst index 1e2b53cf..a28af434 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -1,11 +1,12 @@ Credits ======= -“vim-python-pep8-indent” has been originally written by **David Bustos** and **Eric Mc Sween** who both are unreachable unfortunately. +``vim-python-pep8-indent`` has been originally written by **David Bustos** and **Eric Mc Sween** who both are unreachable unfortunately. -It is currently maintained by Hynek Schlawack with the generous help of the following contributors: +It is currently maintained by `Hynek Schlawack `_ with the generous help of the following contributors: - 0player +- Bryan Bennett - Clay Gerrard - Hassan Kibirige - Jelte Fennema diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 74fe90d7..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,25 +0,0 @@ -# How To Contribute - -“vim-python-pep8-indent” is always open for suggestions and contributions by generous developers. I’ve collected a few tipps to get you started. - -Please: - -- *Always* add tests for your code. -- Add yourself to the AUTHORS.rst file in an alphabetical fashion by first name – no matter how big or small your changes are. -- Write [good commit messages]. -- Ideally, [squash] your commits, i.e. make your pull requests just one commit. - -## Running Tests - -- They are written in ruby (sorry :() using [vimrunner] which requires [rspec] -- The tests go into `spec/indent/indent_spec.rb`. - Look at the `describe` blocks to get the hang of it. -- Run the tests with the command `rspec spec` - -Thank you for considering to contribute! - - -[squash]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html -[good commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html -[vimrunner]: https://github.com/AndrewRadev/vimrunner -[rspec]: https://github.com/rspec/rspec diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 00000000..8e1fc2f5 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,30 @@ +How To Contribute +================= + +``vim-python-pep8-indent`` is always open for suggestions and contributions by generous developers. +I’ve collected a few tips to get you started. + +Please: + +- *Always* add tests for your code. +- Add yourself to the AUTHORS.rst file in an alphabetical fashion by first name – no matter how big or small your changes are. +- Write `good commit messages`_. + + +Running Tests +------------- + +- They are written in Ruby_ (sorry :() using vimrunner_ which requires rspec_. +- The tests go into ``spec/indent/indent_spec.rb``. + Look at the ``describe`` blocks to get the hang of it. +- Run the tests with the command:: + + $ rspec spec + +Thank you for considering to contribute! + + +.. _Ruby: https://www.ruby-lang.org/ +.. _`good commit messages`: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html +.. _vimrunner: https://github.com/AndrewRadev/vimrunner +.. _rspec: https://github.com/rspec/rspec diff --git a/COPYING.txt b/COPYING.txt new file mode 100644 index 00000000..0e259d42 --- /dev/null +++ b/COPYING.txt @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/README.rst b/README.rst index d962240b..71953154 100644 --- a/README.rst +++ b/README.rst @@ -4,53 +4,99 @@ 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 :: +and:: foobar( foo, bar ) -It was *not* originally written by me. I have found the script in vim’s `script -repo`_, however the indentation was off by one character in the first case. -I fixed it with the help of `Steve Losh`_ and am putting it out here so you -don’t have to patch the original. The original patch is still available here_. +Installation +------------ -While my Vimscript_ skills are still feeble, I intend to maintain it for now. -So feel free to report bugs, I’ll try to address them as good as possible if -they fit into the scope of this project. -Unfortunately, I wasn’t able to reach any of the original authors/maintainers: -**David Bustos** and **Eric Mc Sween**. I’d like to thank them here for their -work and release it hereby to the *Public Domain*. If anyone – who has a say in -this – objects, please let me know. +Pathogen +^^^^^^^^ -Installation ------------- +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 + + +Vundle +^^^^^^ + +Follow the instructions on installing Vundle_ and add the appropriate plugin line into your ``.vimrc``: + +.. code-block:: vim + + Plugin 'hynek/vim-python-pep8-indent' + + +NeoBundle +^^^^^^^^^ + +Follow the instructions on installing NeoBundle_ and add the appropriate NeoBundle line into your ``.vimrc``: -The easiest way is to use pathogen_ and do a :: +.. code-block:: vim - git clone https://github.com/hynek/vim-python-pep8-indent.git + NeoBundle 'hynek/vim-python-pep8-indent' -in your `~/.vim/bundle`. And you *should* use pathogen. Really. -Please note that Kirill Klenov’s python-mode_ ships an own version of this bundle. -Therefore, if you want to use this version specifically, you’ll have to disable python-mode’s using: :: +Notes +----- + +Please note that Kirill Klenov’s python-mode_ ships its own version of this bundle. +Therefore, if you want to use this version specifically, you’ll have to disable python-mode’s using: + +.. code-block:: vim let g:pymode_indent = 0 + +License and Authorship +---------------------- + +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. +The original patch is still available here_. + +Over the time a lot more improvements have been contributed_ by `generous people`_. + +I’d like to thank the original authors here for their work and release it hereby to the *Public Domain* (using the CC0_ licence) since I hope that would be in their spirit. +If anyone with a say in this objects, please let me_ know immediately. +Also, if someone is in contact with one of them, I would appreciate being introduced. + +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/ .. _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/ .. _here: https://gist.github.com/2965846 -.. _`Vimscript`: http://learnvimscriptthehardway.stevelosh.com/ -.. _pathogen: https://github.com/tpope/vim-pathogen +.. _Neobundle: https://github.com/Shougo/neobundle.vim +.. _Pathogen: https://github.com/tpope/vim-pathogen .. _python-mode: https://github.com/klen/python-mode +.. _`Vimscript`: http://learnvimscriptthehardway.stevelosh.com/ +.. _vundle: https://github.com/gmarik/Vundle.vim +.. _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 diff --git a/indent/python.vim b/indent/python.vim index d1465665..461e30c9 100644 --- a/indent/python.vim +++ b/indent/python.vim @@ -3,7 +3,19 @@ " Maintainer: Hynek Schlawack " Prev Maintainer: Eric Mc Sween (address invalid) " Original Author: David Bustos (address invalid) -" License: Public Domain +" License: CC0 +" +" vim-python-pep8-indent - A nicer Python indentation style for vim. +" Written in 2004 by David Bustos +" Maintained from 2004-2005 by Eric Mc Sween +" Maintained from 2013 by Hynek Schlawack +" +" To the extent possible under law, the author(s) have dedicated all copyright +" and related and neighboring rights to this software to the public domain +" worldwide. This software is distributed without any warranty. +" You should have received a copy of the CC0 Public Domain Dedication along +" with this software. If not, see +" . " Only load this indent file when no other was loaded. if exists("b:did_indent")