]> git.madduck.net Git - etc/vim.git/blobdiff - docs/index.rst

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

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.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Fix arithmetic stability issue (#2817)
[etc/vim.git] / docs / index.rst
index 1515697f5569afcab35f8ad3b07cbd8f5f27690b..8a8da0d6127e45137082cd8eb118571e1e8c9cc2 100644 (file)
@@ -4,6 +4,8 @@
 The uncompromising code formatter
 =================================
 
+    “Any color you like.”
+
 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
@@ -16,16 +18,14 @@ can focus on the content instead.
 
 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
@@ -99,6 +99,7 @@ Contents
 .. toctree::
    :maxdepth: 3
    :includehidden:
+   :caption: User Guide
 
    getting_started
    usage_and_configuration/index
@@ -107,8 +108,9 @@ Contents
    faq
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 2
    :includehidden:
+   :caption: Development
 
    contributing/index
    change_log
@@ -116,10 +118,11 @@ Contents
 
 .. toctree::
    :hidden:
+   :caption: Project Links
 
-   GitHub ↪ <https://github.com/psf/black>
-   PyPI ↪ <https://pypi.org/project/black>
-   Chat ↪ <https://discord.gg/RtVdv86PrH>
+   GitHub <https://github.com/psf/black>
+   PyPI <https://pypi.org/project/black>
+   Chat <https://discord.gg/RtVdv86PrH>
 
 Indices and tables
 ==================