]> git.madduck.net Git - etc/vim.git/blobdiff - docs/the_black_code_style/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:

Bump furo from 2022.1.2 to 2022.2.14.1 in /docs (GH-2892)
[etc/vim.git] / docs / the_black_code_style / index.rst
index 7c2e1753937cb61159fb88e6bb29d32f78d8d66f..511a6ecf0998cc2427d88f57afdfcf3f5d69da88 100644 (file)
@@ -10,8 +10,12 @@ The Black Code Style
 *Black* is a PEP 8 compliant opinionated formatter with its own style.
 
 While keeping the style unchanged throughout releases has always been a goal,
 *Black* is a PEP 8 compliant opinionated formatter with its own style.
 
 While keeping the style unchanged throughout releases has always been a goal,
-the *Black* code style isn't set in stone. It evolves to accomodate for new features
-in the Python language and, ocassionally, in response to user feedback.
+the *Black* code style isn't set in stone. It evolves to accommodate for new features
+in the Python language and, occasionally, in response to user feedback.
+Large-scale style preferences presented in :doc:`current_style` are very unlikely to
+change, but minor style aspects and details might change according to the stability
+policy presented below. Ongoing style considerations are tracked on GitHub with the
+`design <https://github.com/psf/black/labels/T%3A%20design>`_ issue label.
 
 Stability Policy
 ----------------
 
 Stability Policy
 ----------------
@@ -32,7 +36,7 @@ versions of *Black*:
   improved formatting enabled by newer Python language syntax as well as due
   to improvements in the formatting logic.
 
   improved formatting enabled by newer Python language syntax as well as due
   to improvements in the formatting logic.
 
-- The ``--future`` flag is exempt from this policy. There are no guarentees
+- The ``--preview`` flag is exempt from this policy. There are no guarantees
   around the stability of the output with that flag passed into *Black*. This
   flag is intended for allowing experimentation with the proposed changes to
   the *Black* code style.
   around the stability of the output with that flag passed into *Black*. This
   flag is intended for allowing experimentation with the proposed changes to
   the *Black* code style.