- State we're now stable and that we'll uphold our formatting changes as per policy
- Link to The Black Style doc.
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
- [Usage and Configuration](https://black.readthedocs.io/en/stable/usage_and_configuration/index.html)
-### 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, and 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.
+projects, small and big. _Black_ has a comprehensive test suite, with efficient parallel
+tests, and our own auto formatting and parallel Continuous Integration runner. Now that
+we have become stable, you should not expect large formatting to changes in the future.
+Stylistic changes will mostly be responses to bug reports and support for new Python
+syntax. For more information please refer to the
+[The Black Code Style](docs/the_black_code_style/index.rst).
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
## Is Black safe to use?
-Yes, for the most part. _Black_ is strictly about formatting, nothing else. But because
-_Black_ is still in [beta](index.rst), some edges are still a bit rough. To combat
-issues, the equivalence of code after formatting is
+Yes. _Black_ is strictly about formatting, nothing else. Black strives to ensure that
+after formatting the AST is
[checked](the_black_code_style/current_style.md#ast-before-and-after-formatting) with
limited special cases where the code is allowed to differ. If issues are found, an error
is raised and the file is left untouched. Magical comments that influence linters and
## How stable is Black's style?
-Quite stable. _Black_ aims to enforce one style and one style only, with some room for
-pragmatism. However, _Black_ is still in beta so style changes are both planned and
-still proposed on the issue tracker. See
-[The Black Code Style](the_black_code_style/index.rst) for more details.
+Stable. _Black_ aims to enforce one style and one style only, with some room for
+pragmatism. See [The Black Code Style](the_black_code_style/index.rst) for more details.
Starting in 2022, the formatting output will be stable for the releases made in the same
year (other than unintentional bugs). It is possible to opt-in to the latest formatting
Try it out now using the `Black Playground <https://black.vercel.app>`_.
-.. admonition:: Note - this is a beta product
+.. admonition:: Note - Black is now stable!
- *Black* is already `successfully used <https://github.com/psf/black#used-by>`_ by
+ *Black* is `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.
+ parallel tests, our own auto formatting and parallel Continuous Integration runner.
+ Now that we have become stable, you should not expect large formatting to changes in
+ the future. Stylistic changes will mostly be responses to bug reports and support for new Python
+ syntax.
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