Skip to content

Commit

Permalink
Add docstring to load_recording to confirm that it does the right thing
Browse files Browse the repository at this point in the history
  • Loading branch information
jleibs committed Oct 16, 2024
1 parent 5932b75 commit b7edd99
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions rerun_py/src/dataframe.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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)?;
Expand Down

0 comments on commit b7edd99

Please sign in to comment.