From 3b48445c1274868a55fb6da33ea6fd2cd24329fb Mon Sep 17 00:00:00 2001
From: tangkong <tangkongrobert@gmail.com>
Date: Mon, 16 Sep 2024 21:10:55 -0700
Subject: [PATCH] DOC: flesh out docstring, pre-release notes

---
 atef/bin/main.py                              |  7 ++++++
 .../upcoming_release_notes/256-perf_cli.rst   | 22 +++++++++++++++++++
 2 files changed, 29 insertions(+)
 create mode 100644 docs/source/upcoming_release_notes/256-perf_cli.rst

diff --git a/atef/bin/main.py b/atef/bin/main.py
index 16da0696..229cdafd 100644
--- 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
new file mode 100644
index 00000000..83a1709b
--- /dev/null
+++ 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