X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/c75abed63ef284d7de54db87777951d6c668eefc..14d84ba2e96c5ca1351b8fe4d0d415cc148f4117:/docs/the_black_code_style/index.rst diff --git a/docs/the_black_code_style/index.rst b/docs/the_black_code_style/index.rst index 7c2e175..511a6ec 100644 --- a/docs/the_black_code_style/index.rst +++ b/docs/the_black_code_style/index.rst @@ -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, -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 `_ issue label. 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. -- 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.