Skip to content

Commit f1bed45

Browse files
committed
Fix frame_ being interpreted as a cross-reference by sphinx
1 parent 71ab414 commit f1bed45

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

movement/io/save_bboxes.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,15 +65,16 @@ def to_via_tracks_file(
6565
... )
6666
6767
Export a ``movement`` bounding boxes dataset as a VIA-tracks CSV file,
68-
with image filenames following the format ``frame_{frame_number}.jpg``
68+
with image filenames following the format ``frame-<frame_number>.jpg``
6969
and the track IDs derived from the list of sorted individuals:
7070
>>> save_boxes.to_via_tracks_file(
7171
... ds,
7272
... "/path/to/output.csv",
73-
... image_file_prefix="frame_",
73+
... image_file_prefix="frame-",
7474
... image_file_suffix=".jpg",
7575
... )
7676
77+
7778
"""
7879
# Validate file path and dataset
7980
file = _validate_file_path(file_path, expected_suffix=[".csv"])

0 commit comments

Comments
 (0)