Skip to content

Commit 3adac86

Browse files
committed
Use module docstring for benchmark help description
1 parent 24d0441 commit 3adac86

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

benchmarks/benchmarking.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -145,10 +145,10 @@ def _parse_parameter_overrides(parameter_overrides):
145145
)
146146

147147

148-
def _parse_cli_arguments():
148+
def _parse_cli_arguments(description):
149149
"""Parse command line arguments passed for controlling benchmark runs"""
150150
parser = argparse.ArgumentParser(
151-
"Run benchmarks", formatter_class=argparse.ArgumentDefaultsHelpFormatter
151+
description=description, formatter_class=argparse.ArgumentDefaultsHelpFormatter
152152
)
153153
parser.add_argument(
154154
"-number-runs",
@@ -305,11 +305,11 @@ def parse_args_collect_and_run_benchmarks(module=None):
305305
Dictionary containing timing (and potentially memory usage) results for each
306306
parameters set of each benchmark function.
307307
"""
308-
args = _parse_cli_arguments()
309-
parameter_overrides = _parse_parameter_overrides(args.parameter_overrides)
310308
if module is None:
311309
frame = inspect.stack()[1]
312310
module = inspect.getmodule(frame[0])
311+
args = _parse_cli_arguments(module.__doc__)
312+
parameter_overrides = _parse_parameter_overrides(args.parameter_overrides)
313313
results = run_benchmarks(
314314
benchmarks=collect_benchmarks(module),
315315
number_runs=args.number_runs,

0 commit comments

Comments
 (0)