Skip to content

Commit c12bcf6

Browse files
committed
fix: Update README
1 parent fb31d05 commit c12bcf6

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,9 @@ pybag inspect attachments recording.mcap --name "calib.yaml" --data
279279

280280
### event
281281

282-
Manage events in MCAP files. Events are markers that indicate when something
282+
Manage events in MCAP files.
283+
284+
Events are markers that indicate when something
283285
significant happens in the recording (e.g., collisions, waypoints, incidents).
284286
Events are stored as metadata records.
285287

@@ -289,7 +291,6 @@ Events are stored as metadata records.
289291
pybag event list recording.mcap
290292
pybag event list recording.mcap --name "collision"
291293
pybag event list recording.mcap --json
292-
pybag event list recording.mcap --include-deleted # show soft deleted events
293294
```
294295

295296
**Add events:**
@@ -309,14 +310,9 @@ pybag event add recording.mcap "collision" 10.5 -o with_event.mcap
309310

310311
**Delete events:**
311312

312-
By default, events are soft deleted (marked as deleted without rewriting the file).
313313
Use `-o` to copy the MCAP and hard delete (remove) the events from the copy.
314314

315315
```bash
316-
# Soft delete (default): marks events as deleted in place
317-
pybag event delete recording.mcap --name "collision"
318-
319-
# Hard delete: copies MCAP and removes events from the copy
320316
pybag event delete recording.mcap --name "collision" -o cleaned.mcap
321317
pybag event delete recording.mcap --start-time 5.0 --end-time 10.0 -o cleaned.mcap
322318
```

0 commit comments

Comments
 (0)