DOC: flesh out docstring, pre-release notes

pcdshub · Sep 17, 2024 · 3b48445 · 3b48445
1 parent 8e8ca2d
commit 3b48445
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/atef/bin/main.py b/atef/bin/main.py
@@ -20,6 +20,13 @@ def main():
     """
     Create the top-level parser for atef.  Gathers subparsers from
     atef.bin.subparsers, which have been separated to avoid pre-mature imports
+
+    Expects SUBCOMMANDS to be a dictionary mapping subcommand name to a tuple of:
+    - sub-parser builder function: Callable[[], argparse.ArgumentParser]
+    - function returning the main function for the sub command:
+      Callable[[], Callable[**subcommand_kwargs]]
+
+    Have fun "parsing" this ;D
     """
     top_parser = argparse.ArgumentParser(
         prog='atef',

diff --git a/docs/source/upcoming_release_notes/256-perf_cli.rst b/docs/source/upcoming_release_notes/256-perf_cli.rst
@@ -0,0 +1,22 @@
+256 perf_cli
+############
+
+API Breaks
+----------
+- N/A
+
+Features
+--------
+- N/A
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- improves the performance of the CLI entrypoint, defering functional imports as longas possible
+
+Contributors
+------------
+- tangkong