Describe how string literals are handled (#96)

[etc/vim.git] / black.py

diff --git a/black.py b/black.py
index 3d5ea14736e0c6aca41a75c9cc517130802b5076..3bb83daef28c396cd7670503d7ad21c7d20336c2 100644 (file)
--- a/black.py
+++ b/black.py
@@ -1815,6 +1815,13 @@ def normalize_prefix(leaf: Leaf, *, inside_brackets: bool) -> None:
 
 
 def normalize_string_quotes(leaf: Leaf) -> None:
+    """Prefer double quotes but only if it doesn't cause more escaping.
+
+    Adds or removes backslashes as appropriate. Doesn't parse and fix
+    strings nested in f-strings (yet).
+
+    Note: Mutates its argument.
+    """
     value = leaf.value.lstrip("furbFURB")
     if value[:3] == '"""':
         return