Skip to content

Commit

Permalink
Fix the signatures
Browse files Browse the repository at this point in the history
  • Loading branch information
jleibs committed Dec 18, 2024
1 parent dd635ef commit b3003d3
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion rerun_py/rerun_bindings/rerun_bindings.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -615,7 +615,27 @@ class StorageNodeClient:
"""
Open a [`Recording`][rerun.dataframe.Recording] by id to use with the dataframe APIs.
This currently downloads the full recording to the local machine.
This will run queries against the remote storage node and stream the results. Faster for small
numbers of queries with small results.
Parameters
----------
id : str
The id of the recording to open.
Returns
-------
Recording
The opened recording.
"""
...

def download_recording(self, id: str) -> Recording:
"""
Download a [`Recording`][rerun.dataframe.Recording] by id to use with the dataframe APIs.
This will download the full recording to memory and run queries against a local chunk store.
Parameters
----------
Expand Down

0 comments on commit b3003d3

Please sign in to comment.