From eb01cdc18b71d175a8aa1b137196f6976b47ed70 Mon Sep 17 00:00:00 2001 From: Benjamin Alan Weaver Date: Fri, 2 Aug 2024 12:17:34 -0700 Subject: [PATCH] update docstring --- speclite/benchmark.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/speclite/benchmark.py b/speclite/benchmark.py index a5007a7..38a053b 100644 --- a/speclite/benchmark.py +++ b/speclite/benchmark.py @@ -85,6 +85,13 @@ def magnitude_calculation(results, num_repeats): def main(argv=None): + """Entry-point for :command:`speclite_benchmark`. + + Returns + ------- + :class:`int` + An integer suitable for passing to :func:`sys.exit`. + """ # parse command-line arguments parser = argparse.ArgumentParser( formatter_class=argparse.ArgumentDefaultsHelpFormatter)