diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f8a19653a..2465d7a5e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ https://github.com/bheisler/criterion.rs/issues ## A Note on Dependency Updates Criterion.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 diff --git a/book/src/analysis.md b/book/src/analysis.md index 335671cf1..0f917d104 100644 --- a/book/src/analysis.md +++ b/book/src/analysis.md @@ -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. diff --git a/book/src/user_guide/html_report/Fibonacci/Iterative/report/index.html b/book/src/user_guide/html_report/Fibonacci/Iterative/report/index.html index 7b29c71c3..fbe5c3c0a 100644 --- a/book/src/user_guide/html_report/Fibonacci/Iterative/report/index.html +++ b/book/src/user_guide/html_report/Fibonacci/Iterative/report/index.html @@ -180,7 +180,7 @@

Additional Plots:

Understanding this report:

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.

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 diff --git a/book/src/user_guide/html_report/Fibonacci/Recursive/report/index.html b/book/src/user_guide/html_report/Fibonacci/Recursive/report/index.html index 1564f7b34..1f84b0627 100644 --- a/book/src/user_guide/html_report/Fibonacci/Recursive/report/index.html +++ b/book/src/user_guide/html_report/Fibonacci/Recursive/report/index.html @@ -180,7 +180,7 @@

Additional Plots:

Understanding this report:

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.

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 diff --git a/book/src/user_guide/html_report/Fibonacci2/Iterative/20/report/index.html b/book/src/user_guide/html_report/Fibonacci2/Iterative/20/report/index.html index 0173d39ea..fe4fdf4ff 100644 --- a/book/src/user_guide/html_report/Fibonacci2/Iterative/20/report/index.html +++ b/book/src/user_guide/html_report/Fibonacci2/Iterative/20/report/index.html @@ -180,7 +180,7 @@

Additional Plots:

Understanding this report:

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.

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 diff --git a/book/src/user_guide/html_report/Fibonacci2/Iterative/21/report/index.html b/book/src/user_guide/html_report/Fibonacci2/Iterative/21/report/index.html index 8adcd8727..cdbf22690 100644 --- a/book/src/user_guide/html_report/Fibonacci2/Iterative/21/report/index.html +++ b/book/src/user_guide/html_report/Fibonacci2/Iterative/21/report/index.html @@ -180,7 +180,7 @@

Additional Plots:

Understanding this report:

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.

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 diff --git a/book/src/user_guide/html_report/Fibonacci2/Recursive/20/report/index.html b/book/src/user_guide/html_report/Fibonacci2/Recursive/20/report/index.html index db43c2c70..148f2bada 100644 --- a/book/src/user_guide/html_report/Fibonacci2/Recursive/20/report/index.html +++ b/book/src/user_guide/html_report/Fibonacci2/Recursive/20/report/index.html @@ -180,7 +180,7 @@

Additional Plots:

Understanding this report:

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.

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 diff --git a/book/src/user_guide/html_report/Fibonacci2/Recursive/21/report/index.html b/book/src/user_guide/html_report/Fibonacci2/Recursive/21/report/index.html index 5c30170a1..a1a7993d1 100644 --- a/book/src/user_guide/html_report/Fibonacci2/Recursive/21/report/index.html +++ b/book/src/user_guide/html_report/Fibonacci2/Recursive/21/report/index.html @@ -180,7 +180,7 @@

Additional Plots:

Understanding this report:

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.

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 diff --git a/plot/src/lib.rs b/plot/src/lib.rs index c890df78e..8f31dab6e 100644 --- a/plot/src/lib.rs +++ b/plot/src/lib.rs @@ -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 { @@ -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 ), } diff --git a/src/measurement.rs b/src/measurement.rs index 5bc5f179d..415d8e768 100644 --- a/src/measurement.rs +++ b/src/measurement.rs @@ -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 {