From 402b17af08c45e31e4d78637a6e3c9ea0a14d531 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Caron?= Date: Tue, 3 Dec 2024 16:02:21 +0100 Subject: [PATCH] Documentation fixes --- qpbenchmark/problem_list.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/qpbenchmark/problem_list.py b/qpbenchmark/problem_list.py index 4b35af6..b1fc42a 100644 --- 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.