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.
1 .. black documentation master file, created by
2 sphinx-quickstart on Fri Mar 23 10:53:30 2018.
4 The uncompromising code formatter
5 =================================
7 By using *Black*, you agree to cede control over minutiae of
8 hand-formatting. In return, *Black* gives you speed, determinism, and
9 freedom from `pycodestyle` nagging about formatting. You will save time
10 and mental energy for more important matters.
12 *Black* makes code review faster by producing the smallest diffs
13 possible. Blackened code looks the same regardless of the project
14 you're reading. Formatting becomes transparent after a while and you
15 can focus on the content instead.
17 Try it out now using the `Black Playground <https://black.now.sh>`_.
21 `Black is beta <installation_and_usage.html#note-this-is-a-beta-product>`_.
27 **Dusty Phillips**, `writer <https://smile.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=dusty+phillips>`_:
29 *Black is opinionated so you don't have to be.*
31 **Hynek Schlawack**, creator of `attrs <https://www.attrs.org/>`_, core
32 developer of Twisted and CPython:
34 *An auto-formatter that doesn't suck is all I want for Xmas!*
36 **Carl Meyer**, `Django <https://www.djangoproject.com/>`_ core developer:
38 *At least the name is good.*
40 **Kenneth Reitz**, creator of `requests <http://python-requests.org/>`_
41 and `pipenv <https://docs.pipenv.org/>`_:
43 *This vastly improves the formatting of our code. Thanks a ton!*
51 installation_and_usage
58 version_control_integration
60 ignoring_unmodified_files
64 reference/reference_summary