X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/3dea6e363562050ae032c80a648bd88fc49381bc..64887aab032c0fd64f9238cdab6684f2fc0c7f33:/docs/the_black_code_style/index.md diff --git a/docs/the_black_code_style/index.md b/docs/the_black_code_style/index.md index d150855..1719347 100644 --- a/docs/the_black_code_style/index.md +++ b/docs/the_black_code_style/index.md @@ -17,20 +17,25 @@ Python language and, occasionally, in response to user feedback. Large-scale sty 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. +[style](https://github.com/psf/black/labels/T%3A%20style) issue label. + +(labels/stability-policy)= ## Stability Policy The following policy applies for the _Black_ code style, in non pre-release versions of _Black_: -- The same code, formatted with the same options, will produce the same output for all - releases in a given calendar year. +- If code has been formatted with _Black_, it will remain unchanged when formatted with + the same options using any other release in the same calendar year. + + This means projects can safely use `black ~= 22.0` without worrying about formatting + changes disrupting their project in 2022. We may still fix bugs where _Black_ crashes + on some code, and make other improvements that do not affect formatting. - This means projects can safely use `black ~= 22.0` without worrying about major - formatting changes disrupting their project in 2022. We may still fix bugs where - _Black_ crashes on some code, and make other improvements that do not affect - formatting. + In rare cases, we may make changes affecting code that has not been previously + formatted with _Black_. For example, we have had bugs where we accidentally removed + some comments. Such bugs can be fixed without breaking the stability policy. - The first release in a new calendar year _may_ contain formatting changes, although these will be minimised as much as possible. This is to allow for improved formatting