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

Simplification: only yield empty omit list when magic trailing comma is present
[etc/vim.git] / docs / black_primer.md
index 4d6ce27e037e76bf5a55db6b425527b4af1af028..a2dd964b7dc53d485292eccb2d8248235d858b32 100644 (file)
@@ -51,10 +51,10 @@ Options:
   -h, --help             Show this message and exit.
 ```
 
-## primer config file
+## Primer config file
 
-The config is JSON format. Its main element is the `"projects"` dictionary. Below
-explains each parameter:
+The config file is in JSON format. Its main element is the `"projects"` dictionary and
+each parameter is explained below:
 
 ```json
 {
@@ -71,12 +71,15 @@ explains each parameter:
       "expect_formatting_changes": true,
       "git_clone_url": "https://github.com/cooperlees/aioexabgp.git",
       "long_checkout": false,
-      "py_versions": ["all", "3.8"] // "all" ignores all other versions
+      "py_versions": ["all", "3.8"]
     }
   }
 }
 ```
 
+An example primer config file is used by Black
+[here](https://github.com/psf/black/blob/master/src/black_primer/primer.json)
+
 ## Example run
 
 ```console
@@ -100,9 +103,9 @@ Failed projects:
 +++ tests/b303_b304.py 2020-05-17 20:06:42.753851 +0000
 @@ -26,11 +26,11 @@
      maxint = 5  # this is okay
-     # the following shouldn't crash
+     # the following should not crash
      (a, b, c) = list(range(3))
-     # it's different than this
+     # it is different than this
      a, b, c = list(range(3))
 -    a, b, c, = list(range(3))
 +    a, b, c = list(range(3))