update docstring

desihub · Aug 2, 2024 · eb01cdc · eb01cdc
1 parent d45c7a8
commit eb01cdc
Showing 1 changed file with 7 additions and 0 deletions.
diff --git 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)