Skip to content

Commit 030dd8f

Browse files
docs: Complete undocumented arguments
1 parent dc2a298 commit 030dd8f

File tree

3 files changed

+7
-1
lines changed

3 files changed

+7
-1
lines changed

qpbenchmark/parquet_test_set.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@ class ParquetTestSet(TestSet):
2121
"""Test set read from a Parquet file."""
2222

2323
def __init__(self, path: Union[str, Path]):
24+
"""Initialize test set.
25+
26+
Args:
27+
path: Path to Parquet file to read problems from.
28+
"""
2429
super().__init__()
2530
self.__df = pandas.read_parquet(path, engine="pyarrow")
2631

qpbenchmark/problem_list.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def extend(
4141
"""Extend problem list with another.
4242
4343
Args:
44-
problems: Other problem list.
44+
problem_list: Other problem list.
4545
"""
4646
if isinstance(problem_list, ProblemList):
4747
for key in self.KEYS:

qpbenchmark/run.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ def run(
3939
only_solver: If set, only run that specific solver.
4040
rerun: If set, rerun instances that already have a result.
4141
rerun_timeouts: If set, also rerun known timeouts.
42+
verbose: If set, log info messages for each QP solver call.
4243
"""
4344
if only_settings and only_settings not in test_set.solver_settings:
4445
raise ValueError(

0 commit comments

Comments
 (0)