Add docstrings to fmt checking functions, add to docs

Follow up from #1325

Adds docstrings to the fmt checking functions.
Renames fmt_on to is_fmt_on.
Adds the functions to the autodocs.

diff --git a/black.py b/black.py
index fc1597a44342d751fcd6f165ca3c7a59abddd3ce..2b718f63a52b5b387c267058bec0fb1691fd9305 100644 (file)
--- a/black.py
+++ b/black.py
@@ -5232,7 +5232,7 @@ def generate_ignored_nodes(leaf: Leaf) -> Iterator[LN]:
     """
     container: Optional[LN] = container_of(leaf)
     while container is not None and container.type != token.ENDMARKER:
     """
     container: Optional[LN] = container_of(leaf)
     while container is not None and container.type != token.ENDMARKER:

-        if fmt_on(container):
+        if is_fmt_on(container):

             return
 
         # fix for fmt: on in children
             return
 
         # fix for fmt: on in children


@@ -5246,17 +5246,21 @@ def generate_ignored_nodes(leaf: Leaf) -> Iterator[LN]:
             container = container.next_sibling
 
 
             container = container.next_sibling
 
 

-def fmt_on(container: LN) -> bool:
-    is_fmt_on = False
+def is_fmt_on(container: LN) -> bool:
+    """Determine whether formatting is switched on within a container.
+    Determined by whether the last `# fmt:` comment is `on` or `off`.
+    """
+    fmt_on = False

     for comment in list_comments(container.prefix, is_endmarker=False):
         if comment.value in FMT_ON:
     for comment in list_comments(container.prefix, is_endmarker=False):
         if comment.value in FMT_ON:

-            is_fmt_on = True
+            fmt_on = True

         elif comment.value in FMT_OFF:
         elif comment.value in FMT_OFF:

-            is_fmt_on = False
-    return is_fmt_on
+            fmt_on = False
+    return fmt_on

 
 
 def contains_fmt_on_at_column(container: LN, column: int) -> bool:
 
 
 def contains_fmt_on_at_column(container: LN, column: int) -> bool:

+    """Determine if children at a given column have formatting switched on."""

     for child in container.children:
         if (
             isinstance(child, Node)
     for child in container.children:
         if (
             isinstance(child, Node)


@@ -5264,13 +5268,14 @@ def contains_fmt_on_at_column(container: LN, column: int) -> bool:
             or isinstance(child, Leaf)
             and child.column == column
         ):
             or isinstance(child, Leaf)
             and child.column == column
         ):

-            if fmt_on(child):
+            if is_fmt_on(child):

                 return True
 
     return False
 
 
 def first_leaf_column(node: Node) -> Optional[int]:
                 return True
 
     return False
 
 
 def first_leaf_column(node: Node) -> Optional[int]:

+    """Returns the column of the first leaf child of a node."""

     for child in node.children:
         if isinstance(child, Leaf):
             return child.column
     for child in node.children:
         if isinstance(child, Leaf):
             return child.column

diff --git a/docs/reference/reference_functions.rst b/docs/reference/reference_functions.rst
index 459e4980ae7030f011e3d875f402e8d29b8dc65c..fc5cefb241b79e6e72e7b5eed3d2fb85014c963e 100644 (file)
--- a/docs/reference/reference_functions.rst
+++ b/docs/reference/reference_functions.rst
@@ -135,6 +135,12 @@ Utilities
 
 .. autofunction:: black.generate_ignored_nodes
 
 
 .. autofunction:: black.generate_ignored_nodes
 

+.. autofunction:: black.is_fmt_on
+
+.. autofunction:: black.contains_fmt_on_at_column
+
+.. autofunction:: black.first_leaf_column
+

 .. autofunction:: black.generate_trailers_to_omit
 
 .. autofunction:: black.get_future_imports
 .. autofunction:: black.generate_trailers_to_omit
 
 .. autofunction:: black.get_future_imports