Skip to content

Commit 206ee28

Browse files
committed
naming
Signed-off-by: Andrea Reale <andrea@rerun.io>
1 parent 9f81e17 commit 206ee28

2 files changed

Lines changed: 14 additions & 12 deletions

File tree

rerun_py/rerun_bindings/rerun_bindings.pyi

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1437,9 +1437,10 @@ class DatasetEntry(Entry):
14371437
14381438
"""
14391439

1440-
def register_prefix(self, recordings_prefix: str, recordings_layer: str | None = None) -> Tasks:
1440+
def register_prefix(self, recordings_prefix: str, layer_name: str | None = None) -> Tasks:
14411441
"""
1442-
Register all RRDs under a given prefix to the dataset and return a handle to the tasks.
1442+
Register all RRDs under a given prefix (i.e., an object store directory )
1443+
to the dataset and return a handle to the tasks.
14431444
14441445
This method initiates the registration of multiple recordings to the dataset, and returns
14451446
the corresponding task ids in a [`Tasks`] object.
@@ -1449,7 +1450,7 @@ class DatasetEntry(Entry):
14491450
recordings_prefix: str
14501451
The prefix under which to register all RRDs.
14511452
1452-
recordings_layer: Optional[str]
1453+
layer_name: Optional[str]
14531454
The layer to which the recordings will be registered to.
14541455
If `None`, this defaults to `"base"`.
14551456

rerun_py/src/catalog/dataset_entry.rs

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -324,29 +324,30 @@ impl PyDatasetEntry {
324324
Ok(task_descriptor.partition_id.id)
325325
}
326326

327-
/// Register all RRDs under a given prefix to the dataset and return a handle to the tasks.
328-
///
327+
/// Register all RRDs under a given prefix (i.e., an object store directory )
328+
/// to the dataset and return a handle to the tasks.
329+
329330
/// This method initiates the registration of multiple recordings to the dataset, and returns
330331
/// the corresponding task ids in a [`Tasks`] object.
331-
///
332+
332333
/// Parameters
333334
/// ----------
334335
/// recordings_prefix: str
335336
/// The prefix under which to register all RRDs.
336-
///
337-
/// recordings_layer: Optional[str]
337+
338+
/// layer_name: Optional[str]
338339
/// The layer to which the recordings will be registered to.
339340
/// If `None`, this defaults to `"base"`.
340341
#[allow(clippy::allow_attributes, rustdoc::broken_intra_doc_links)]
341342
#[pyo3(signature = (
342343
recordings_prefix,
343-
recordings_layer = None,
344+
layer_name = None,
344345
))]
345-
#[pyo3(text_signature = "(self, /, recordings_prefix, recordings_layer = None)")]
346+
#[pyo3(text_signature = "(self, /, recordings_prefix, layer_name = None)")]
346347
fn register_prefix(
347348
self_: PyRef<'_, Self>,
348349
recordings_prefix: String,
349-
recordings_layer: Option<String>,
350+
layer_name: Option<String>,
350351
) -> PyResult<PyTasks> {
351352
let super_ = self_.as_super();
352353
let connection = super_.client.borrow(self_.py()).connection().clone();
@@ -356,7 +357,7 @@ impl PyDatasetEntry {
356357
self_.py(),
357358
dataset_id,
358359
recordings_prefix,
359-
recordings_layer,
360+
layer_name,
360361
)?;
361362

362363
Ok(PyTasks::new(

0 commit comments

Comments
 (0)