Primer: pyramid and sqlalchemy are now formatted with latest Black (#1736)

[etc/vim.git] / docs / black_primer.md

diff --git a/docs/black_primer.md b/docs/black_primer.md
index 4d6ce27e037e76bf5a55db6b425527b4af1af028..a2dd964b7dc53d485292eccb2d8248235d858b32 100644 (file)
--- a/docs/black_primer.md
+++ b/docs/black_primer.md
@@ -51,10 +51,10 @@ Options:
   -h, --help             Show this message and exit.
 ```
 
   -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
 {
 
 ```json
 {


@@ -71,12 +71,15 @@ explains each parameter:
       "expect_formatting_changes": true,
       "git_clone_url": "https://github.com/cooperlees/aioexabgp.git",
       "long_checkout": false,
       "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
 ## 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
 +++ 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))
      (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))
      a, b, c = list(range(3))
 -    a, b, c, = list(range(3))
 +    a, b, c = list(range(3))