.. black documentation master file, created by
sphinx-quickstart on Fri Mar 23 10:53:30 2018.
-Black
-=====
+The uncompromising code formatter
+=================================
-**Black** is the uncompromising Python code formatter.
-
-By using *Black*, you
-agree to cease control over minutiae of hand-formatting. In return,
-*Black* gives you speed, determinism, and freedom from `pycodestyle`
-nagging about formatting. You will save time and mental energy for
-more important matters.
+By using *Black*, you agree to cede control over minutiae of
+hand-formatting. In return, *Black* gives you speed, determinism, and
+freedom from `pycodestyle` nagging about formatting. You will save time
+and mental energy for more important matters.
*Black* makes code review faster by producing the smallest diffs
possible. Blackened code looks the same regardless of the project
you're reading. Formatting becomes transparent after a while and you
can focus on the content instead.
-.. note::
+Try it out now using the `Black Playground <https://black.vercel.app>`_.
- Black is an early pre-release.
+.. admonition:: Note - this is a beta product
+ *Black* is already `successfully used <https://github.com/psf/black#used-by>`_ by
+ many projects, small and big. *Black* has a comprehensive test suite, with efficient
+ parallel tests, our own auto formatting and parallel Continuous Integration runner.
+ However, *Black* is still beta. Things will probably be wonky for a while. This is
+ made explicit by the "Beta" trove classifier, as well as by the "b" in the version
+ number. What this means for you is that **until the formatter becomes stable, you
+ should expect some formatting to change in the future**. That being said, no drastic
+ stylistic changes are planned, mostly responses to bug reports.
+
+ Also, as a safety measure which slows down processing, *Black* will check that the
+ reformatted code still produces a valid AST that is effectively equivalent to the
+ original (see the
+ `Pragmatism <./the_black_code_style/current_style.html#pragmatism>`_
+ section for details). If you're feeling confident, use ``--fast``.
+
+.. note::
+ :doc:`Black is licensed under the MIT license <license>`.
Testimonials
------------
*Black is opinionated so you don't have to be.*
-**Hynek Schlawack**, creator of `attrs <http://www.attrs.org/>`_, core
+**Hynek Schlawack**, creator of `attrs <https://www.attrs.org/>`_, core
developer of Twisted and CPython:
*An auto-formatter that doesn't suck is all I want for Xmas!*
*This vastly improves the formatting of our code. Thanks a ton!*
+
+Show your style
+---------------
+
+Use the badge in your project's README.md:
+
+.. code-block:: md
+
+ [](https://github.com/psf/black)
+
+
+Using the badge in README.rst:
+
+.. code-block:: rst
+
+ .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+ :target: https://github.com/psf/black
+
+Looks like this:
+
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+ :target: https://github.com/psf/black
+
Contents
--------
.. toctree::
- :maxdepth: 2
+ :maxdepth: 3
+ :includehidden:
+
+ the_black_code_style/index
+
+.. toctree::
+ :maxdepth: 3
+ :includehidden:
+
+ getting_started
+ usage_and_configuration/index
+ integrations/index
+ guides/index
+
+.. toctree::
+ :maxdepth: 3
+ :includehidden:
+
+ contributing/index
+ change_log
+ authors
+
+.. toctree::
+ :hidden:
- usage
- technical_philosophy
- contributors_guide
- changelog
-
+ GitHub ↪ <https://github.com/psf/black>
+ PyPI ↪ <https://pypi.org/project/black>
+ IRC ↪ <https://webchat.freenode.net/?channels=%23blackformatter>
Indices and tables
==================
* :ref:`genindex`
-* :ref:`modindex`
* :ref:`search`
projects / etc / vim.git / blobdiff