]> 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:

Specify the minimum click version (#284)
[etc/vim.git] / README.md
index fbe1136d9501141663d7c6c7f80dbd26dd19d9d6..f0a6babe2fbb7d13349b329c0bb8abe5efe20251 100644 (file)
--- a/README.md
+++ b/README.md
@@ -80,13 +80,15 @@ Options:
   -q, --quiet                 Don't emit non-error messages to stderr. Errors
                               are still emitted, silence those with
                               2>/dev/null.
   -q, --quiet                 Don't emit non-error messages to stderr. Errors
                               are still emitted, silence those with
                               2>/dev/null.
-   --pyi                      Consider all input files typing stubs regardless
+  --pyi                       Consider all input files typing stubs regardless
                               of file extension (useful when piping source on
                               standard input).
   --py36                      Allow using Python 3.6-only syntax on all input
                               files.  This will put trailing commas in function
                               signatures and calls also after *args and
                               **kwargs.  [default: per-file auto-detection]
                               of file extension (useful when piping source on
                               standard input).
   --py36                      Allow using Python 3.6-only syntax on all input
                               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.
 ```
   --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.
 
 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
 
 
 ### Line breaks & binary operators
 
@@ -506,7 +514,7 @@ $ where black
     - Arguments: $FilePath$
 
 5. Format the currently opened file by selecting `Tools -> External Tools -> 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
 
 
 ### Vim
@@ -688,7 +696,12 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Change Log
 
 
 ## Change Log
 
-### 18.5b1 (unreleased)
+### 18.6b0
+
+* added `--skip-string-normalization` (#118)
+
+
+### 18.5b1
 
 * added `--pyi` (#249)
 
 
 * added `--pyi` (#249)