Skip to content

Commit 505843b

Browse files
Update some outdated documentation.
1 parent 771697a commit 505843b

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

measureme/src/lib.rs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,10 @@
1313
//! To create a [`Profiler`], call the [`Profiler::new()`] function and provide a `Path` with
1414
//! the directory and file name for the trace files.
1515
//!
16-
//! To record an event, call the [`Profiler::record_event()`] method, passing a few arguments:
16+
//! To record an event, call the [`Profiler::record_instant_event()`] method, passing a few arguments:
1717
//! - `event_kind`: a [`StringId`] which assigns an arbitrary category to the event
1818
//! - `event_id`: a [`StringId`] which specifies the name of the event
19-
//! - `thread_id`: a `u64` id of the thread which is recording this event
20-
//! - `timestamp_kind`: a [`TimestampKind`] which specifies how this event should be treated by `measureme` tooling
19+
//! - `thread_id`: a `u32` id of the thread which is recording this event
2120
//!
2221
//! Alternatively, events can also be recorded via the [`Profiler::start_recording_interval_event()`] method. This
2322
//! method records a "start" event and returns a `TimingGuard` object that will automatically record

0 commit comments

Comments
 (0)