Fix documentation typos and man-page formatting

CHANGELOG.md

@@ -5,7 +5,7 @@
 - Add `--reference-name` option to give a meaningful name to the reference command, see #808 (@niklasdewally)
 - The `--ignore-failure` option now supports a comma-separated list of exit codes to ignore (e.g., `--ignore-failure=1,2`), see #836 (@sharkdp)
 - Python scripts: Add `--time-unit` option to `advanced_statistics.py` (@sharkdp)
-- Python scripts: Add new `plot_benchmarks.py` script for plotting collections of benchmarks, see #806 (@marxin)
+- Python scripts: Add new `plot_benchmark_comparison.py` script for plotting collections of benchmarks, see #806 (@marxin)
 
 ## Bugfixes
 
@@ -99,7 +99,7 @@
 ## Other
 
 - Thanks to @berombau for working on dependency upgrades, see #584
-- Fixed installationm on Windows, see #595 and #596 (@AntoniosBarotsis)
+- Fixed installation on Windows, see #595 and #596 (@AntoniosBarotsis)
 
 
 # v1.15.0
@@ -244,10 +244,10 @@ Package authors: note that Hyperfine now comes with a set of shell completion fi
 - The new `--parameter-list <VAR> <VALUES>` option can be used to run
   a parametrized benchmark on a user-specified list of values.
   This is similar to `--parameter-scan <VAR> <MIN> <MAX>`, but doesn't
-  necessarily required numeric arguments.
+  necessarily require numeric arguments.
 
   ``` bash
-  hyperfine --parameter-list compiler "g++,clang++" \
+  hyperfine --parameter-list compiler "gcc,clang" \
       "{compiler} -O2 main.cpp"
   ```
 
@@ -415,7 +415,7 @@ for reviewing pull requests and for giving very valuable feedback.
 ## Other
 
 - [Arch Linux package](https://aur.archlinux.org/packages/hyperfine) for Hyperfine (@jD91mZM2).
-- Ubuntu/Debian packages are now are available.
+- Ubuntu/Debian packages are now available.
 
 # v0.2.0
 

README.md

@@ -84,7 +84,7 @@ This runs `sleep 0.3`, `sleep 0.5` and `sleep 0.7`.
 For non-numeric parameters, you can also supply a list of values with the `-L`/`--parameter-list`
 option:
 ```
-hyperfine -L compiler g++,clang++ '{compiler} -O2 main.cpp'
+hyperfine -L compiler gcc,clang '{compiler} -O2 main.cpp'
 ```
 
 ### Intermediate shell
@@ -334,7 +334,7 @@ The name *hyperfine* was chosen in reference to the hyperfine levels of caesium
 
 ## Citing hyperfine
 
-Thank you for considering to cite hyperfine in your research work. Please see the information
+Thank you for considering citing hyperfine in your research work. Please see the information
 in the sidebar on how to properly cite hyperfine.
 
 ## License

doc/hyperfine.1

@@ -105,7 +105,7 @@ Perform exactly \fINUM\fP runs for each command. If this option is not specified
 \fB\-s\fR, \fB\-\-setup\fR \fICMD...\fP
 .IP
 Execute \fICMD\fP once before each set of timing runs. This is useful
-for compiling your software or with the provided parameters, or to do any
+for compiling your software with the provided parameters, or to do any
 other work that should happen once before a series of benchmark runs,
 not every time as would happen with the \fB\-\-prepare\fR option.
 .HP
@@ -129,8 +129,8 @@ run after the corresponding benchmark command.
 .IP
 Execute \fICMD\fP after the completion of all benchmarking runs for each individual
 command to be benchmarked. This is useful if the commands to be benchmarked
-produce artifacts that need to be cleaned up. It only runs once a series of
-benchmark runs, as opposed to \fB\-\-conclude\fR option which runs after
+produce artifacts that need to be cleaned up. It only runs once per series of
+benchmark runs, as opposed to the \fB\-\-conclude\fR option which runs after
 every run.
 .HP
 \fB\-P\fR, \fB\-\-parameter\-scan\fR \fIVAR\fP \fIMIN\fP \fIMAX\fP
@@ -148,7 +148,7 @@ Example:
 This performs benchmarks for 'make \-j 1', 'make \-j 2', ..., 'make \-j 8'.
 .IP
 To have the value increase following different patterns, use shell
-arithmetics.
+arithmetic.
 .IP
 .RS
 Example:
@@ -184,11 +184,11 @@ Replaces the string '{\fIVAR\fP}' in each command by the current parameter value
 .RS
 Example:
 .RS
-\fBhyperfine\fR \fB\-L\fR compiler g++,clang++ '{compiler} \-O2 main.cpp'
+\fBhyperfine\fR \fB\-L\fR compiler gcc,clang '{compiler} \-O2 main.cpp'
 .RE
 .RE
 .IP
-This performs benchmarks for 'g++ \-O2 main.cpp' and 'clang++ \-O2 main.cpp'.
+This performs benchmarks for 'gcc \-O2 main.cpp' and 'clang \-O2 main.cpp'.
 .IP
 The option can be specified multiple times to run benchmarks for all
 possible parameter combinations.
@@ -309,9 +309,9 @@ Read from \fI\,/dev/null\/\fP (the default).
 Read the input from the given file.
 .RE
 .HP
-\fB\-n\fR, \fB\-\-command\-name\fR \fiNAME\fP
+\fB\-n\fR, \fB\-\-command\-name\fR \fINAME\fP
 .IP
-Give a meaningful \fiNAME\fP to a command. This can be specified multiple times
+Give a meaningful \fINAME\fP to a command. This can be specified multiple times
 if several commands are benchmarked.
 .HP
 \fB\-h\fR, \fB\-\-help\fR
@@ -363,7 +363,6 @@ Demonstrate when each of \fB\-\-setup\fR, \fB\-\-prepare\fR, \fB\-\-conclude\fR,
 	'echo command n={n}'
 .fi
 .RE
-.RE
 .SH AUTHOR
 .LP
 David Peter <mail@david-peter.de>

scripts/README.md

@@ -1,4 +1,4 @@
-This folder contains scripts that can be used in combination with hyperfines `--export-json` option.
+This folder contains scripts that can be used in combination with hyperfine's `--export-json` option.
 
 ### Example:
 
@@ -7,7 +7,7 @@ hyperfine 'sleep 0.020' 'sleep 0.021' 'sleep 0.022' --export-json sleep.json
 ./plot_whisker.py sleep.json
 ```
 
-### Pre-requisites
+### Prerequisites
 
 To make these scripts work, you will need `numpy`, `matplotlib` and `scipy`.
 

src/cli.rs

@@ -194,8 +194,8 @@ fn build_command() -> Command {
                 .help(
                     "Perform benchmark runs for each value in the comma-separated list VALUES. \
                      Replaces the string '{VAR}' in each command by the current parameter value\
-                     .\n\nExample:  hyperfine -L compiler g++,clang++ '{compiler} -O2 main.cpp'\n\n\
-                     This performs benchmarks for 'g++ -O2 main.cpp' and 'clang++ -O2 main.cpp'.\n\n\
+                     .\n\nExample:  hyperfine -L compiler gcc,clang '{compiler} -O2 main.cpp'\n\n\
+                     This performs benchmarks for 'gcc -O2 main.cpp' and 'clang -O2 main.cpp'.\n\n\
                      The option can be specified multiple times to run benchmarks for all \
                      possible parameter combinations.\n"
                 ),