Remove Beta mentions in README + Docs (#2801)

- 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>
This commit is contained in:
Cooper Lees 2022-01-23 12:34:01 -08:00 committed by GitHub
parent 6e3677f3f0
commit d2c938eb02
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 24 deletions

View File

@ -64,16 +64,13 @@ Further information can be found in our docs:
- [Usage and Configuration](https://black.readthedocs.io/en/stable/usage_and_configuration/index.html) - [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 _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 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, tests, and our own auto formatting and parallel Continuous Integration runner. Now that
_Black_ is still beta. Things will probably be wonky for a while. This is made explicit we have become stable, you should not expect large formatting to changes in the future.
by the "Beta" trove classifier, as well as by the "b" in the version number. What this Stylistic changes will mostly be responses to bug reports and support for new Python
means for you is that **until the formatter becomes stable, you should expect some syntax. For more information please refer to the
formatting to change in the future**. That being said, no drastic stylistic changes are [The Black Code Style](docs/the_black_code_style/index.rst).
planned, mostly responses to bug reports.
Also, as a safety measure which slows down processing, _Black_ will check that the 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 reformatted code still produces a valid AST that is effectively equivalent to the

View File

@ -17,9 +17,8 @@ though.
## Is Black safe to use? ## Is Black safe to use?
Yes, for the most part. _Black_ is strictly about formatting, nothing else. But because Yes. _Black_ is strictly about formatting, nothing else. Black strives to ensure that
_Black_ is still in [beta](index.rst), some edges are still a bit rough. To combat after formatting the AST is
issues, the equivalence of code after formatting is
[checked](the_black_code_style/current_style.md#ast-before-and-after-formatting) with [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 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 is raised and the file is left untouched. Magical comments that influence linters and
@ -27,10 +26,8 @@ other tools, such as `# noqa`, may be moved by _Black_. See below for more detai
## How stable is Black's style? ## How stable is Black's style?
Quite stable. _Black_ aims to enforce one style and one style only, with some room for 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 pragmatism. See [The Black Code Style](the_black_code_style/index.rst) for more details.
still proposed on the issue tracker. 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 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 year (other than unintentional bugs). It is possible to opt-in to the latest formatting

View File

@ -18,16 +18,14 @@ can focus on the content instead.
Try it out now using the `Black Playground <https://black.vercel.app>`_. 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 many projects, small and big. *Black* has a comprehensive test suite, with efficient
parallel tests, our own auto formatting and parallel Continuous Integration runner. 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 Now that we have become stable, you should not expect large formatting to changes in
made explicit by the "Beta" trove classifier, as well as by the "b" in the version the future. Stylistic changes will mostly be responses to bug reports and support for new Python
number. What this means for you is that **until the formatter becomes stable, you syntax.
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 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 reformatted code still produces a valid AST that is effectively equivalent to the