]> git.madduck.net Git - etc/vim.git/blob - docs/the_black_code_style/index.md

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:

Reformat codebase with isort
[etc/vim.git] / docs / the_black_code_style / index.md
1 # The Black Code Style
2
3 ```{toctree}
4 ---
5 hidden:
6 ---
7
8 Current style <current_style>
9 Future style <future_style>
10 ```
11
12 _Black_ is a PEP 8 compliant opinionated formatter with its own style.
13
14 While keeping the style unchanged throughout releases has always been a goal, the
15 _Black_ code style isn't set in stone. It evolves to accommodate for new features in the
16 Python language and, occasionally, in response to user feedback. Large-scale style
17 preferences presented in {doc}`current_style` are very unlikely to change, but minor
18 style aspects and details might change according to the stability policy presented
19 below. Ongoing style considerations are tracked on GitHub with the
20 [design](https://github.com/psf/black/labels/T%3A%20design) issue label.
21
22 ## Stability Policy
23
24 The following policy applies for the _Black_ code style, in non pre-release versions of
25 _Black_:
26
27 - If code has been formatted with _Black_, it will remain unchanged when formatted with
28   the same options using any other release in the same calendar year.
29
30   This means projects can safely use `black ~= 22.0` without worrying about formatting
31   changes disrupting their project in 2022. We may still fix bugs where _Black_ crashes
32   on some code, and make other improvements that do not affect formatting.
33
34   In rare cases, we may make changes affecting code that has not been previously
35   formatted with _Black_. For example, we have had bugs where we accidentally removed
36   some comments. Such bugs can be fixed without breaking the stability policy.
37
38 - The first release in a new calendar year _may_ contain formatting changes, although
39   these will be minimised as much as possible. This is to allow for improved formatting
40   enabled by newer Python language syntax as well as due to improvements in the
41   formatting logic.
42
43 - The `--preview` flag is exempt from this policy. There are no guarantees around the
44   stability of the output with that flag passed into _Black_. This flag is intended for
45   allowing experimentation with the proposed changes to the _Black_ code style.
46
47 Documentation for both the current and future styles can be found:
48
49 - {doc}`current_style`
50 - {doc}`future_style`