Skip to content
This repository has been archived by the owner on Jun 8, 2024. It is now read-only.

Commit

Permalink
fix up doc typocs
Browse files Browse the repository at this point in the history
  • Loading branch information
KodrAus committed May 20, 2024
1 parent 7d48008 commit 6816bda
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion core/src/clock.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ pub trait Clock {
/**
Read the current time.
This method may return `None` if the clock couldn't be read for any reason. That may involve the clock not actually supporting reading now, time moving backwards, or any other reason that could result in an innacurate reading.
This method may return `None` if the clock couldn't be read for any reason. That may involve the clock not actually supporting reading now, time moving backwards, or any other reason that could result in an inaccurate reading.
*/
fn now(&self) -> Option<Timestamp>;
}
Expand Down
2 changes: 1 addition & 1 deletion core/src/emitter.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ use crate::{
};

/**
An asychronous destination for diagnostic datas.
An asynchronous destination for diagnostic data.
Once [`Event`]s are emitted through [`Emitter::emit`], a call to [`Emitter::blocking_flush`] must be made to ensure they're fully processed. This should be done once before the emitter is disposed, but may be more frequent for auditing.
*/
Expand Down
4 changes: 2 additions & 2 deletions core/src/rng.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ The [`Rng`] type.
use crate::empty::Empty;

/**
A non-crypographic source of randomness.
A non-cryptographic source of randomness.
*/
pub trait Rng {
/**
Fill a buffer with random data.
This method may return `None` if the buffer couldn't be filled with randmo data for any reason.
This method may return `None` if the buffer couldn't be filled with random data for any reason.
The buffer is expected to have a consistent implementation of `AsMut` that always returns a reference to the same underlying bytes. This isn't required for safety, but can lead to unexpected results.
*/
Expand Down
2 changes: 1 addition & 1 deletion core/src/value.rs
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ impl<'v> Value<'v> {
/**
Get a serializable value.
This mehod can be used instead of [`Value::capture_serde`] when the value can't satisfy the `'static` bound.
This method can be used instead of [`Value::capture_serde`] when the value can't satisfy the `'static` bound.
*/
#[cfg(feature = "serde")]
#[track_caller]
Expand Down
8 changes: 4 additions & 4 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -913,7 +913,7 @@ emit::emit!(
);
```
The data model of metrics is an extension of `emit`'s events. Metric events are points or buckets in a timeseries. They don't model the underlying instruments collecting metrics like counters or gauges. They instead model the aggregation of readings from those instruments over their lifetime. Metric events include the following well-known properties:
The data model of metrics is an extension of `emit`'s events. Metric events are points or buckets in a time-series. They don't model the underlying instruments collecting metrics like counters or gauges. They instead model the aggregation of readings from those instruments over their lifetime. Metric events include the following well-known properties:
- `event_kind`: with a value of `"metric"` to indicate that the event is a metric sample.
- `metric_agg`: the aggregation over the underlying data stream that produced the sample.
Expand Down Expand Up @@ -1008,11 +1008,11 @@ Event {
}
```
### Timeseries metrics
### Time-series metrics
Metric events with a span extent, where the `metric_value` is an array are a complete timeseries. Each element in the array is a bucket in the timeseries. The width of each bucket is the length of the extent divided by the number of buckets.
Metric events with a span extent, where the `metric_value` is an array are a complete time-series. Each element in the array is a bucket in the time-series. The width of each bucket is the length of the extent divided by the number of buckets.
The following metric is for a timeseries with 15 buckets, where each bucket covers 1 second:
The following metric is for a time-series with 15 buckets, where each bucket covers 1 second:
```
use emit::{Clock, well_known::METRIC_AGG_COUNT};
Expand Down

0 comments on commit 6816bda

Please sign in to comment.