Skip to content

Commit

Permalink
Fix typos.
Browse files Browse the repository at this point in the history
  • Loading branch information
waywardmonkeys committed Jul 10, 2024
1 parent 58f7ca4 commit 8945930
Show file tree
Hide file tree
Showing 10 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ https://github.com/bheisler/criterion.rs/issues
## A Note on Dependency Updates

Criterion.<span></span>rs does not accept pull requests to update dependencies unless specifically
requested by the maintaner(s). Dependencies are updated manually by the maintainer(s) before each
requested by the maintainer(s). Dependencies are updated manually by the maintainer(s) before each
new release.

## Code
Expand Down
2 changes: 1 addition & 1 deletion book/src/analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ As measurement progresses, the sample iteration counts are increased. Suppose th

`iterations = [d, 2d, 3d, ... Nd]`

Where `N` is the total number of samples and `d` is a factor, calculated from the rough estimate of iteration time measured during the warmup period, which is used to scale the number of iterations to meet the configured measurement time. Note that `d` cannot be less than 1, and therefore the actual measurment time may exceed the configured measurement time if the iteration time is large or the configured measurement time is small.
Where `N` is the total number of samples and `d` is a factor, calculated from the rough estimate of iteration time measured during the warmup period, which is used to scale the number of iterations to meet the configured measurement time. Note that `d` cannot be less than 1, and therefore the actual measurement time may exceed the configured measurement time if the iteration time is large or the configured measurement time is small.

Note that Criterion.rs does not measure each individual iteration, only the complete sample. The resulting samples are stored for use in later stages. The sample data is also written to the local disk so that it can be used in the comparison phase of future benchmark runs.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ <h4>Additional Plots:</h4>
<section class="explanation">
<h4>Understanding this report:</h4>
<p>The plot on the left displays the average time per iteration for this benchmark. The shaded region
shows the estimated probabilty of an iteration taking a certain amount of time, while the line
shows the estimated probability of an iteration taking a certain amount of time, while the line
shows the mean. Click on the plot for a larger view showing the outliers.</p>
<p>The plot on the right shows the linear regression calculated from the measurements. Each point
represents a sample, though here it shows the total time for the sample rather than time per
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ <h4>Additional Plots:</h4>
<section class="explanation">
<h4>Understanding this report:</h4>
<p>The plot on the left displays the average time per iteration for this benchmark. The shaded region
shows the estimated probabilty of an iteration taking a certain amount of time, while the line
shows the estimated probability of an iteration taking a certain amount of time, while the line
shows the mean. Click on the plot for a larger view showing the outliers.</p>
<p>The plot on the right shows the linear regression calculated from the measurements. Each point
represents a sample, though here it shows the total time for the sample rather than time per
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ <h4>Additional Plots:</h4>
<section class="explanation">
<h4>Understanding this report:</h4>
<p>The plot on the left displays the average time per iteration for this benchmark. The shaded region
shows the estimated probabilty of an iteration taking a certain amount of time, while the line
shows the estimated probability of an iteration taking a certain amount of time, while the line
shows the mean. Click on the plot for a larger view showing the outliers.</p>
<p>The plot on the right shows the linear regression calculated from the measurements. Each point
represents a sample, though here it shows the total time for the sample rather than time per
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ <h4>Additional Plots:</h4>
<section class="explanation">
<h4>Understanding this report:</h4>
<p>The plot on the left displays the average time per iteration for this benchmark. The shaded region
shows the estimated probabilty of an iteration taking a certain amount of time, while the line
shows the estimated probability of an iteration taking a certain amount of time, while the line
shows the mean. Click on the plot for a larger view showing the outliers.</p>
<p>The plot on the right shows the linear regression calculated from the measurements. Each point
represents a sample, though here it shows the total time for the sample rather than time per
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ <h4>Additional Plots:</h4>
<section class="explanation">
<h4>Understanding this report:</h4>
<p>The plot on the left displays the average time per iteration for this benchmark. The shaded region
shows the estimated probabilty of an iteration taking a certain amount of time, while the line
shows the estimated probability of an iteration taking a certain amount of time, while the line
shows the mean. Click on the plot for a larger view showing the outliers.</p>
<p>The plot on the right shows the linear regression calculated from the measurements. Each point
represents a sample, though here it shows the total time for the sample rather than time per
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ <h4>Additional Plots:</h4>
<section class="explanation">
<h4>Understanding this report:</h4>
<p>The plot on the left displays the average time per iteration for this benchmark. The shaded region
shows the estimated probabilty of an iteration taking a certain amount of time, while the line
shows the estimated probability of an iteration taking a certain amount of time, while the line
shows the mean. Click on the plot for a larger view showing the outliers.</p>
<p>The plot on the right shows the linear regression calculated from the measurements. Each point
represents a sample, though here it shows the total time for the sample rather than time per
Expand Down
4 changes: 2 additions & 2 deletions plot/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -936,7 +936,7 @@ pub enum VersionError {
Error(String),
/// The `gnuplot` command returned invalid utf-8
OutputError,
/// The `gnuplot` command returned an unparseable string
/// The `gnuplot` command returned an unparsable string
ParseError(String),
}
impl fmt::Display for VersionError {
Expand All @@ -949,7 +949,7 @@ impl fmt::Display for VersionError {
VersionError::OutputError => write!(f, "`gnuplot --version` returned invalid utf-8"),
VersionError::ParseError(msg) => write!(
f,
"`gnuplot --version` returned an unparseable version string: {}",
"`gnuplot --version` returned an unparsable version string: {}",
msg
),
}
Expand Down
2 changes: 1 addition & 1 deletion src/measurement.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ use std::time::{Duration, Instant};
/// nanoseconds, the values passed to the formatter will be in nanoseconds).
///
/// Implementors are encouraged to format the values in a way that is intuitive for humans and
/// uses the SI prefix system. For example, the format used by [`WallTime`] can dsiplay the value
/// uses the SI prefix system. For example, the format used by [`WallTime`] can display the value
/// in units ranging from picoseconds to seconds depending on the magnitude of the elapsed time
/// in nanoseconds.
pub trait ValueFormatter {
Expand Down

0 comments on commit 8945930

Please sign in to comment.