Fixup: update function name in docs to match source (#1997)

diff --git a/docs/reference/reference_functions.rst b/docs/reference/reference_functions.rst
index a7184115c9454a889ed31d8860fdb1327aa43162..bffce7e9e325b439ed1ad33d7b359f8f0372f512 100644 (file)
--- a/docs/reference/reference_functions.rst
+++ b/docs/reference/reference_functions.rst
@@ -171,7 +171,7 @@ Utilities
 
 .. autofunction:: black.re_compile_maybe_verbose
 
 
 .. autofunction:: black.re_compile_maybe_verbose
 

-.. autofunction:: black.should_split_body_explode
+.. autofunction:: black.should_split_line

 
 .. autofunction:: black.shutdown
 
 
 .. autofunction:: black.shutdown
 

diff --git a/src/black/__init__.py b/src/black/__init__.py
index e09f08df7dff335f61bc0489d4d2f5724e853754..07251d55fb543169ff34ef29e3993e73d0473f26 100644 (file)
--- a/src/black/__init__.py
+++ b/src/black/__init__.py
@@ -1480,7 +1480,7 @@ class Line:
     comments: Dict[LeafID, List[Leaf]] = field(default_factory=dict)
     bracket_tracker: BracketTracker = field(default_factory=BracketTracker)
     inside_brackets: bool = False
     comments: Dict[LeafID, List[Leaf]] = field(default_factory=dict)
     bracket_tracker: BracketTracker = field(default_factory=BracketTracker)
     inside_brackets: bool = False

-    should_split: bool = False
+    should_split_rhs: bool = False

     magic_trailing_comma: Optional[Leaf] = None
 
     def append(self, leaf: Leaf, preformatted: bool = False) -> None:
     magic_trailing_comma: Optional[Leaf] = None
 
     def append(self, leaf: Leaf, preformatted: bool = False) -> None:


@@ -1792,7 +1792,7 @@ class Line:
             mode=self.mode,
             depth=self.depth,
             inside_brackets=self.inside_brackets,
             mode=self.mode,
             depth=self.depth,
             inside_brackets=self.inside_brackets,

-            should_split=self.should_split,
+            should_split_rhs=self.should_split_rhs,

             magic_trailing_comma=self.magic_trailing_comma,
         )
 
             magic_trailing_comma=self.magic_trailing_comma,
         )
 


@@ -2712,7 +2712,7 @@ def transform_line(
     transformers: List[Transformer]
     if (
         not line.contains_uncollapsable_type_comments()
     transformers: List[Transformer]
     if (
         not line.contains_uncollapsable_type_comments()

-        and not line.should_split
+        and not line.should_split_rhs

         and not line.magic_trailing_comma
         and (
             is_line_short_enough(line, line_length=mode.line_length, line_str=line_str)
         and not line.magic_trailing_comma
         and (
             is_line_short_enough(line, line_length=mode.line_length, line_str=line_str)


@@ -4387,7 +4387,7 @@ class StringParenWrapper(CustomSplitMapMixin, BaseStringSplitter):
             mode=line.mode,
             depth=line.depth + 1,
             inside_brackets=True,
             mode=line.mode,
             depth=line.depth + 1,
             inside_brackets=True,

-            should_split=line.should_split,
+            should_split_rhs=line.should_split_rhs,

             magic_trailing_comma=line.magic_trailing_comma,
         )
         string_leaf = Leaf(token.STRING, string_value)
             magic_trailing_comma=line.magic_trailing_comma,
         )
         string_leaf = Leaf(token.STRING, string_value)


@@ -5010,7 +5010,7 @@ def bracket_split_build_line(
         for comment_after in original.comments_after(leaf):
             result.append(comment_after, preformatted=True)
     if is_body and should_split_line(result, opening_bracket):
         for comment_after in original.comments_after(leaf):
             result.append(comment_after, preformatted=True)
     if is_body and should_split_line(result, opening_bracket):

-        result.should_split = True
+        result.should_split_rhs = True

     return result
 
 
     return result