Documentation fixes

qpsolvers · Dec 3, 2024 · 402b17a · 402b17a
1 parent bd773f0
commit 402b17a
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/qpbenchmark/problem_list.py b/qpbenchmark/problem_list.py
@@ -16,6 +16,7 @@
 
 
 class ProblemList:
+    """List of problems saved to and read from Parquet files."""
 
     KEYS = ("P", "q", "G", "h", "A", "b", "lb", "ub", "name")
 
@@ -54,7 +55,7 @@ def yield_from_parquet(cls, path: Union[str, Path]) -> Iterator[Problem]:
         """Yield sequence of problems from a Parquet file.
 
         Args:
-            file: Path to the Parquet file to read problems from.
+            path: Path to the Parquet file to read problems from.
 
         Yields:
             Problem object read from file.