docs: add module-level doc

vega · Dec 18, 2024 · f4bbda8 · f4bbda8
1 parent 859975e
commit f4bbda8
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/scripts/flights2.py b/scripts/flights2.py
@@ -5,6 +5,20 @@
 #     "polars",
 # ]
 # ///
+"""
+Retrieve, extract, transform, and export  `BTS`_ (U.S.) `On-Time Flight Performance`_-derived datasets.
+
+See Also
+--------
+``Flights``
+``Spec``
+
+.. _BTS:
+    https://www.transtats.bts.gov/Homepage.asp
+.. _On-Time Flight Performance:
+    https://www.transtats.bts.gov/TableInfo.asp?gnoyr_VQ=FGJ&QO_fu146_anzr=b0-gvzr&V0s1_b0yB=D
+"""
+
 from __future__ import annotations
 
 # ruff: noqa: PLC1901
@@ -38,7 +52,6 @@
 
 logger = logging.getLogger(__name__)
 
-
 type Rows = Literal[
     1_000,
     2_000,