X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/0171a5e524387c201973dce9e4c9117eb1b0c115..99c97c3d7fa8532faf11f818bf1fcf08e991e62c:/README.md diff --git a/README.md b/README.md index 5f4e14a..afb160e 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,8 @@ Options: source on standard input). -S, --skip-string-normalization Don't normalize string quotes or prefixes. + -N, --skip-numeric-underscore-normalization + Don't normalize underscores in numeric literals. --check Don't write the files back, just return the status. Return code 0 means nothing would change. Return code 1 means some files would be @@ -141,7 +143,8 @@ original. This slows it down. If you're feeling confident, use *Black* reformats entire files in place. It is not configurable. It doesn't take previous formatting into account. It doesn't reformat -blocks that start with `# fmt: off` and end with `# fmt: on`. It also +blocks that start with `# fmt: off` and end with `# fmt: on`. `# fmt: on/off` +have to be on the same level of indentation. It also recognizes [YAPF](https://github.com/google/yapf)'s block comments to the same effect, as a courtesy for straddling code. @@ -277,7 +280,8 @@ ignore = E501 ``` You'll find *Black*'s own .flake8 config file is configured like this. -If you're curious about the reasoning behind B950, Bugbear's documentation +If you're curious about the reasoning behind B950, +[Bugbear's documentation](https://github.com/PyCQA/flake8-bugbear#opinionated-warnings) explains it. The tl;dr is "it's like highway speed limits, we won't bother you if you overdo it by a few km/h". @@ -671,7 +675,7 @@ Configuration: To install with [vim-plug](https://github.com/junegunn/vim-plug): ``` -Plug 'ambv/black', +Plug 'ambv/black' ``` or with [Vundle](https://github.com/VundleVim/Vundle.vim): @@ -940,16 +944,23 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). * code with `_` in numeric literals is recognized as Python 3.6+ - * most letters in numeric literals are lowercased (e.g., in `1e10` or `0xab`) + * most letters in numeric literals are lowercased (e.g., in `1e10`, `0x01`) + + * hexadecimal digits are always uppercased (e.g. `0xBADC0DE`) * added `blackd`, see [its documentation](#blackd) for more info (#349) * adjacent string literals are now correctly split into multiple lines (#463) +* trailing comma is now added to single imports that don't fit on a line (#250) + * cache is now populated when `--check` is successful for a file which speeds up consecutive checks of properly formatted unmodified files (#448) -* code with `_` in numeric literals is recognized as Python 3.6+ (#461) +* whitespace at the beginning of the file is now removed (#399) + +* fixed mangling [pweave](http://mpastell.com/pweave/) and + [Spyder IDE](https://pythonhosted.org/spyder/) special comments (#532) * fixed unstable formatting when unpacking big tuples (#267) @@ -966,9 +977,6 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). to be a bad idea (#415) -* trailing comma is now added to single imports that don't fit on a line (#250) - - ### 18.6b4 * hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)