X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/059cb1227053e3de086076a37c46fa877342b1e4..3272bbc8b3e17d229df63daf26d3dce9706cee77:/README.md diff --git a/README.md b/README.md index a6c413e..f0a6bab 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,8 @@ Options: files. This will put trailing commas in function signatures and calls also after *args and **kwargs. [default: per-file auto-detection] + -S, --skip-string-normalization + Don't normalize string quotes or prefixes. --version Show the version and exit. --help Show this message and exit. ``` @@ -346,6 +348,12 @@ a bit easier than double quotes. The latter requires use of the Shift key. My recommendation here is to keep using whatever is faster to type and let *Black* handle the transformation. +If you are adopting *Black* in a large project with pre-existing string +conventions (like the popular ["single quotes for data, double quotes for +human-readable strings"](https://stackoverflow.com/a/56190)), you can +pass `--skip-string-normalization` on the command line. This is meant as +an adoption helper, avoid using this for new projects. + ### Line breaks & binary operators @@ -506,7 +514,7 @@ $ where black - Arguments: $FilePath$ 5. Format the currently opened file by selecting `Tools -> External Tools -> black`. - - Alternatively, you can set a keyboard shortcut by navigating to `Preferences -> Keymap`. + - Alternatively, you can set a keyboard shortcut by navigating to `Preferences -> Keymap -> External Tools -> External Tools - Black`. ### Vim @@ -688,7 +696,12 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). ## Change Log -### 18.5b1 (unreleased) +### 18.6b0 + +* added `--skip-string-normalization` (#118) + + +### 18.5b1 * added `--pyi` (#249)