Skip to content

Commit a09f8e2

Browse files
Add README
1 parent 3bdb267 commit a09f8e2

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Blacken
2+
3+
Use the python `black` package to reformat your python buffers.
4+
5+
## usage
6+
7+
The whole buffer can be reformatted with `blacken-buffer`. If you want
8+
to format every time you save, enable `blacken-mode` in relevant
9+
python buffers. Note that if `blacken-only-if-project-is-blackened` is
10+
non-nil, then blacken will only run if your `pyproject.toml` contains
11+
the `[tool.black]` setting. This setting is off by default.
12+
13+
14+
## customization
15+
16+
The following options change the behavior of black when reformatting buffers.
17+
18+
- `blacken-allow-py36` Allow using Python 3.6-only syntax on all input files.
19+
- `blacken-skip-string-normalization` Don't normalize string quotes or prefixes.
20+
- `blacken-fast-unsafe` Skips temporary sanity checks.
21+
- `blacken-line-length` Max line length enforced by blacken.

0 commit comments

Comments
 (0)