]> git.madduck.net Git - etc/vim.git/blobdiff - README.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:

projects / etc / vim.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
acks += Stavros; document fix, add to Pipfile
[etc/vim.git] / README.md
diff --git a/README.md b/README.md
index a6c413e643765c22e25e4a8a2878d8e26844fd6c..12af03f4d7d391e226c57bbfdba1baa47aecd863 100644 (file)
--- 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,15 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Change Log
 
-### 18.5b1 (unreleased)
+### 18.6b0
+
+* added `--skip-string-normalization` (#118)
+
+* fixed stdin handling not working correctly if an old version of Click was
+  used (#276)
+
+
+### 18.5b1
 
 * added `--pyi` (#249)
 
@@ -979,6 +995,7 @@ Multiple contributions by:
 * [Luka Sterbic](mailto:luka.sterbic@gmail.com)
 * [Miguel Gaiowski](mailto:miggaiowski@gmail.com)
 * [Osaetin Daniel](mailto:osaetindaniel@gmail.com)
+* [Stavros Korokithakis](mailto:hi@stavros.io)
 * [Sunil Kapil](mailto:snlkapil@gmail.com)
 * [Vishwas B Sharma](mailto:sharma.vishwas88@gmail.com)
 
vim configuration

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.