Skip to content

Commit 769127e

Browse files
committed
document negative indexing
1 parent 60990cf commit 769127e

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

doc/DataSeries.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333

3434
:arg buffer: A |buffer| to write the frame to (only the first channel is used, will be resized).
3535

36-
Get a frame from a series. If the identifier doesn't exist or if that series doesnt have a frame for that time point an error will be reported.
36+
Get a frame from a series. Negative indexing starts from the last frame. If the identifier doesn't exist or if that series doesnt have a frame for that time point an error will be reported.
3737

3838
:message getSeries:
3939

@@ -51,7 +51,7 @@
5151

5252
:arg buffer: A |buffer| containing the data for the frame (only the first channel is used).
5353

54-
Updates a time frame in a series, or adds it to the end if there is no frame at that time point. Sets the dimensionality of the DataSeries if it is the first frame added, otherwise if the buffer is too short an error will be reported.
54+
Updates a time frame in a series, or adds it to the end if there is no frame at that time point. Negative indexing starts from the last frame. Sets the dimensionality of the DataSeries if it is the first frame added, otherwise if the buffer is too short an error will be reported.
5555

5656
:message setSeries:
5757

@@ -69,7 +69,7 @@
6969

7070
:arg buffer: A |buffer| containing the data for the frame (only the first channel is used).
7171

72-
Updates an existing frame. If the buffer is too short an error will be reported. If the identifier doesn't exist or if that series doesnt have a frame for that time point an error will be reported.
72+
Updates an existing frame. Negative indexing starts from the last frame. If the buffer is too short an error will be reported. If the identifier doesn't exist or if that series doesnt have a frame for that time point an error will be reported.
7373

7474
:message updateSeries:
7575

@@ -85,7 +85,7 @@
8585

8686
:arg time: which time frame to remove.
8787

88-
Delete a frame from a series, deletes the series if it is the only frame. If the identifier doesn't exist or if that series doesnt have a frame for that time point an error will be reported.
88+
Delete a frame from a series, deletes the series if it is the only frame. Negative indexing starts from the last frame. If the identifier doesn't exist or if that series doesnt have a frame for that time point an error will be reported.
8989

9090
:message deleteSeries:
9191

@@ -99,7 +99,7 @@
9999

100100
:arg dataSet: The Dataset to write the slice to. Will overwrite and resize.
101101

102-
Get a dataset with the `time`th frame of every series, i.e. can create a :fluid-obj:`DataSet` with every Nth frame of every series. If an identifier doesn't have enough frames it is merely not added to the output dataset.
102+
Get a dataset with the `time`th frame of every series, i.e. can create a :fluid-obj:`DataSet` with every Nth frame of every series. Negative indexing starts from the last frame. If an identifier doesn't have enough frames it is merely not added to the output dataset.
103103

104104
:message clear:
105105

0 commit comments

Comments
 (0)