]> 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
Make cache work with non-default line lenghts (#163)
[etc/vim.git] / README.md
diff --git a/README.md b/README.md
index 05bff36ffbd010e9010853502e057c65b82854f1..02cf2f92a7646af06ad284f8ef1e3690c5280383 100644 (file)
--- a/README.md
+++ b/README.md
@@ -230,11 +230,9 @@ are always reformatted to fit minimal space, this whitespace is lost.
 
 It will also insert proper spacing before and after function definitions.
 It's one line before and after inner functions and two lines before and
-after module-level functions.  *Black* will put those empty lines also
-between the function definition and any standalone comments that
-immediately precede the given function.  If you want to comment on the
-entire function, use a docstring or put a leading comment in the function
-body.
+after module-level functions.  *Black* will not put empty lines between
+function/class definitions and standalone comments that immediately precede
+the given function/class.
 
 
 ### Trailing commas
@@ -460,9 +458,9 @@ location of the file depends on the black version and the system on which black
 is run. The file is non-portable. The standard location on common operating systems
 is:
 
-* Windows: `C:\\Users\<username>\AppData\Local\black\black\Cache\<version>\cache.pickle`
-* macOS: `/Users/<username>/Library/Caches/black/<version>/cache.pickle`
-* Linux: `/home/<username>/.cache/black/<version>/cache.pickle`
+* Windows: `C:\\Users\<username>\AppData\Local\black\black\Cache\<version>\cache.<line-length>.pickle`
+* macOS: `/Users/<username>/Library/Caches/black/<version>/cache.<line-length>.pickle`
+* Linux: `/home/<username>/.cache/black/<version>/cache.<line-length>.pickle`
 
 
 ## Testimonials
@@ -532,6 +530,9 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 * fixed comment indentation when a standalone comment closes a block (#16, #32)
 
+* fixed standalone comments receiving extra empty lines if immediately preceding
+  a class, def, or decorator (#56, #154)
+
 * fixed `--diff` not showing entire path (#130)
 
 * fixed parsing of complex expressions after star and double stars in
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.