From b7edd999392b3c471e6b5e5a356f5ca698ce733d Mon Sep 17 00:00:00 2001
From: Jeremy Leibs <jeremy@rerun.io>
Date: Tue, 15 Oct 2024 22:08:51 -0400
Subject: [PATCH] Add docstring to load_recording to confirm that it does the
 right thing

---
 rerun_py/src/dataframe.rs | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/rerun_py/src/dataframe.rs b/rerun_py/src/dataframe.rs
index 444a01cc79c49..7abcd262e46f0 100644
--- a/rerun_py/src/dataframe.rs
+++ b/rerun_py/src/dataframe.rs
@@ -834,6 +834,15 @@ impl PyRRDArchive {
     }
 }
 
+/// Load a single recording from an RRD.
+///
+/// Will raise a `ValueError` if the file does not contain exactly one recording.
+///
+/// Parameters
+/// ----------
+/// path_to_rrd : str
+///     The path to the file to load.
+///
 #[pyfunction]
 pub fn load_recording(path_to_rrd: std::path::PathBuf) -> PyResult<PyRecording> {
     let archive = load_archive(path_to_rrd)?;