Skip to content

Commit

Permalink
Consistent empty lines in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
ambv committed May 18, 2018
1 parent e94bda1 commit dafa12f
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,7 @@ if you'd like a trailing comma in this situation and *Black* didn't
recognize it was safe to do so, put it there manually and *Black* will
keep it.


### Strings

*Black* prefers double quotes (`"` and `"""`) over single quotes (`'`
Expand Down Expand Up @@ -297,6 +298,7 @@ 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.


### Line Breaks & Binary Operators

*Black* will break a line before a binary operator when splitting a block
Expand All @@ -308,6 +310,7 @@ This behaviour may raise ``W503 line break before binary operator`` warnings in
style guide enforcement tools like Flake8. Since ``W503`` is not PEP 8 compliant,
you should tell Flake8 to ignore these warnings.


### Slices

PEP 8 [recommends](https://www.python.org/dev/peps/pep-0008/#whitespace-in-expressions-and-statements)
Expand All @@ -321,6 +324,7 @@ This behaviour may raise ``E203 whitespace before ':'`` warnings in style guide
enforcement tools like Flake8. Since ``E203`` is not PEP 8 compliant, you should
tell Flake8 to ignore these warnings.


### Parentheses

Some parentheses are optional in the Python grammar. Any expression can
Expand Down Expand Up @@ -354,6 +358,7 @@ return not (this or that)
decision = (maybe.this() and values > 0) or (maybe.that() and values < 0)
```


### Call chains

Some popular APIs, like ORMs, use call chaining. This API style is known
Expand All @@ -374,6 +379,7 @@ def example(session):
)
```


### Typing stub files

PEP 484 describes the syntax for type hints in Python. One of the
Expand Down Expand Up @@ -504,14 +510,17 @@ to do this.

Use [joslarson.black-vscode](https://marketplace.visualstudio.com/items?itemName=joslarson.black-vscode).


### SublimeText 3

Use [sublack plugin](https://github.com/jgirardet/sublack).


### IPython Notebook Magic

Use [blackcellmagic](https://github.com/csurfer/blackcellmagic).


### Other editors

Atom/Nuclide integration is planned by the author, others will
Expand Down

0 comments on commit dafa12f

Please sign in to comment.