[llvm] [utils][filecheck-lint]: speedup filecheck_lint (PR #94191)

Benjamin Chetioui via llvm-commits llvm-commits at lists.llvm.org
Tue Jun 4 09:10:39 PDT 2024


================
@@ -78,32 +78,41 @@ def levenshtein(s1: str, s2: str) -> int:  # pylint: disable=g-doc-args
 
 
 class FileRange:
-    """Stores the coordinates of a span on a single line within a file.
+    """Derives the coordinates of a span on a single line within a file.
 
     Attributes:
-      line:         the line number
-      start_column: the (inclusive) column where the span starts
-      end_column:   the (inclusive) column where the span ends
+      content:      line str
+      start_byte: the (inclusive) byte offset the span starts
+      end_byte:   the (inclusive) byte offset the span ends
     """
 
-    line: int
-    start_column: int
-    end_column: int
+    content: str
+    start_byte: int
+    end_byte: int
 
     def __init__(
         self, content: str, start_byte: int, end_byte: int
     ):  # pylint: disable=g-doc-args
-        """Derives a span's coordinates based on a string and start/end bytes.
----------------
bchetioui wrote:

This is the [authoritative documentation](https://peps.python.org/pep-0257/#what-is-a-docstring) we [want to follow](https://www.llvm.org/docs/CodingStandards.html#python-version-and-source-code-formatting).

Beyond that though, the docstring of the constructor still actually provides additional information for how it is supposed to be used (hence there is useful information in the docstring), but does not have a summary line---which is non-standard. Please fix.

https://github.com/llvm/llvm-project/pull/94191


More information about the llvm-commits mailing list