Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

How the pages read

How each page reads against the writing guide’s voice limits, written from the pages by the site’s build each time it runs.

cargo xtask voice prints the same report from a copy of the repository. The writing guide’s voice section says what the pattern columns count and why, and sets the limits.

Rates are per 100 words, rounded up to two decimals, so a page over a limit never shows a rate at or under it; a rate over its limit is in bold. Words a sentence and the share of sentences over 25 words are rounded up too, to 0.1 and to 1%, so neither shows a page inside a target it misses. A stock phrase fails the build, and so does a page marked held that’s over a limit or misses a sentence target. The 136 held pages are every page the site’s table of contents lists, with the README and the 404 page, less the records page (ADR-285), each snapshot of an hpr command’s --help, the census of what the commands say, a page for each crate’s src/ directory, the Python package’s README and its docstrings as help() shows them, and each crate’s front page, the //! docs of its src/lib.rs (ADR-292).

144 pages, 595084 words, 0 stock phrases. 140 pages are within every limit.

The limits

PatternLimit per 100 wordsPages over itHighest rate
Bold-label items0.5041.76, docs/perf.md
Labels0.5033.62, docs/VISION.md
Sentences over 25 words0.5031.13, docs/perf.md
Hedges1.0000.52, crates/hpr-sim/src/
Stacked hedges0.1000.03, crates/hpr-sim/src/
Minimizers0.1010.11, docs/ARCHITECTURE.md
Signposts0.1000.01, docs/format/flight-logs.md
First person on a reference page0.000none

The register has no limit of its own (first person on a reference page, above, is the one limit on it): “I”, “we”, “you” and contractions per 100 words, and the guide’s sentence targets (at most 20 words a sentence on average, fewer than 10% of sentences over 25 words). A reference page is marked ref.

Each page

PageWordsWords a sentenceOver 25 wordsBold-label itemsLabelsSentences over 25 wordsHedgesStacked hedgesMinimizersSignpostsFirst person on a reference pageIWeYouContractions
.github/ISSUE_TEMPLATE/an-idea.md280.00%0.000.000.000.000.000.000.000.000.000.000.00
.github/ISSUE_TEMPLATE/something-wrong.md290.00%0.000.000.000.000.000.000.000.000.000.000.00
.github/pull_request_template.md80.00%0.000.000.000.000.000.000.000.000.000.000.00
CHANGELOG.md181020.931%0.940.000.890.060.000.000.000.000.000.060.23
CONTRIBUTING.md71514.15%0.000.000.280.000.000.000.000.000.000.000.98
README.md (held)263714.35%0.160.120.230.040.000.000.000.160.000.760.65
crates/hpr-cli/tests/help/hpr-analyze.help (ref, held)43113.50%0.000.000.000.000.000.000.000.000.000.000.470.00
crates/hpr-cli/tests/help/hpr-compare.help (ref, held)52112.83%0.000.000.200.200.000.000.000.000.000.000.200.00
crates/hpr-cli/tests/help/hpr-completions.help (ref, held)787.80%0.000.000.000.000.000.000.000.000.000.001.290.00
crates/hpr-cli/tests/help/hpr-convert.help (ref, held)17413.40%0.000.000.000.000.000.000.000.000.000.000.000.58
crates/hpr-cli/tests/help/hpr-diagnose.help (ref, held)537.60%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-cli/tests/help/hpr-mc.help (ref, held)61313.10%0.000.000.000.170.000.000.000.000.000.000.000.00
crates/hpr-cli/tests/help/hpr-motors-fetch.help (ref, held)14610.50%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-cli/tests/help/hpr-motors-list.help (ref, held)968.00%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-cli/tests/help/hpr-motors-search.help (ref, held)1599.40%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-cli/tests/help/hpr-motors-show.help (ref, held)969.60%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-cli/tests/help/hpr-motors-update.help (ref, held)10610.60%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-cli/tests/help/hpr-motors.help (ref, held)19011.90%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-cli/tests/help/hpr-optimize.help (ref, held)507.20%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-cli/tests/help/hpr-sim.help (ref, held)44112.60%0.000.000.000.230.000.000.000.000.000.000.000.00
crates/hpr-cli/tests/help/hpr-weather-era5.help (ref, held)1328.80%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-cli/tests/help/hpr-weather-gfs.help (ref, held)1589.90%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-cli/tests/help/hpr-weather-open-meteo.help (ref, held)18910.00%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-cli/tests/help/hpr-weather-rap.help (ref, held)16410.30%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-cli/tests/help/hpr-weather-wyoming.help (ref, held)18210.80%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-cli/tests/help/hpr-weather.help (ref, held)19911.80%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-cli/tests/help/hpr.help (ref, held)30313.25%0.000.000.340.000.000.000.000.000.000.000.000.00
crates/hpr-py/README.md (held)34612.20%0.000.000.000.000.000.000.000.000.000.290.29
crates/hpr-py/tests/docstrings.md (ref, held)437413.93%0.000.000.210.070.000.000.000.000.000.000.070.69
docs/404.md (held)5112.00%0.000.000.000.000.000.000.000.000.001.970.00
docs/ARCHITECTURE.md186011.77%1.132.420.380.060.000.110.000.000.110.000.11
docs/VALIDATION.md (held)1412216.610%0.200.090.430.090.020.000.000.000.000.050.48
docs/VISION.md392715.515%1.133.620.590.180.000.080.000.000.000.030.00
docs/accuracy.md (held)2586215.510%0.260.060.410.060.010.010.000.000.000.010.37
docs/api.md (held)251513.20%0.160.000.000.200.000.000.000.000.000.400.36
docs/checking-a-claim.md (held)157514.80%0.260.070.000.260.000.000.000.000.000.131.21
docs/cli.md (ref, held)2037014.44%0.200.020.240.090.000.000.000.000.000.000.210.61
docs/comparing-a-flight.md (held)109215.18%0.280.100.460.100.000.000.000.000.000.650.92
docs/custom-models.md (held)180013.60%0.000.000.000.230.000.000.000.000.000.950.95
docs/drag-through-mach-1.md (held)195715.03%0.360.000.160.110.000.000.000.000.000.060.82
docs/elevation.md (held)412714.72%0.000.000.100.050.000.000.000.000.000.300.85
docs/evidence.md (held)911512.54%0.000.000.180.030.000.000.000.000.000.020.26
docs/exporting-a-flight.md (held)193114.60%0.000.000.000.060.000.000.000.060.000.210.94
docs/fly-your-ork.md (held)217514.36%0.000.100.330.140.000.000.000.000.000.650.51
docs/format/damaged-files.md (ref, held)84415.66%0.000.000.360.120.000.000.000.000.000.000.361.31
docs/format/eng.md (ref, held)246813.93%0.370.210.170.130.000.000.000.000.000.000.050.21
docs/format/era5.md (ref, held)268113.62%0.380.150.080.040.000.000.000.000.000.000.490.27
docs/format/flight-logs.md (ref, held)4456413.21%0.220.200.020.090.000.010.010.000.000.000.040.45
docs/format/ghost-files.md (ref, held)197415.18%0.000.000.460.060.000.000.000.000.000.000.160.61
docs/format/hpr.md (ref, held)559214.42%0.380.020.110.090.000.000.000.000.000.000.130.79
docs/format/orc.md (ref, held)241213.30%0.380.130.000.090.000.000.000.000.000.000.210.38
docs/format/ork.md (ref, held)4175514.53%0.220.130.130.090.000.010.010.000.000.000.040.16
docs/format/pf2.md (ref, held)81513.90%0.000.130.000.250.000.000.000.000.000.000.001.23
docs/format/rse.md (ref, held)225614.00%0.270.090.000.090.000.000.000.000.000.000.000.05
docs/getting-started.md (held)416013.72%0.270.000.100.100.000.000.000.000.000.870.73
docs/glossary.md (ref, held)1367713.41%0.000.090.060.060.000.020.000.000.000.000.060.13
docs/how-a-flight-is-simulated.md (held)216814.10%0.330.000.000.000.000.000.000.000.000.140.33
docs/monte-carlo.md (held)381514.22%0.210.000.080.080.000.000.000.000.000.420.71
docs/motor-stock.md (held)360614.23%0.000.000.170.120.000.000.000.000.000.371.06
docs/nomads.md (held)448313.61%0.000.000.050.030.000.000.000.000.000.230.79
docs/online-data.md (held)216514.60%0.100.000.000.000.000.000.000.000.000.141.02
docs/optimization.md (held)768014.20%0.230.000.000.110.000.000.000.000.000.280.59
docs/perf.md649317.123%1.760.651.130.040.000.020.000.000.000.000.16
docs/physics/aero.md (ref, held)6549614.93%0.350.320.170.070.010.010.010.000.000.000.020.12
docs/physics/atmosphere.md (ref, held)234912.51%0.130.300.050.000.000.000.000.000.000.000.000.18
docs/physics/design.md (ref, held)1229415.26%0.120.180.320.080.010.000.000.000.000.000.010.48
docs/physics/flight-fit.md (ref, held)770916.19%0.160.250.500.150.030.020.000.000.000.000.000.81
docs/physics/flight.md (ref, held)1218715.48%0.460.180.480.020.000.000.000.000.000.000.020.11
docs/physics/flutter.md (ref, held)343915.97%0.300.060.350.120.000.000.000.000.000.000.120.15
docs/physics/frames.md (ref, held)163413.76%0.000.000.370.000.000.000.000.000.000.000.000.00
docs/physics/geodesy.md (ref, held)173412.21%0.240.000.060.000.000.000.000.000.000.000.120.06
docs/physics/gravity.md (ref, held)134513.05%0.000.000.300.000.000.000.000.000.000.000.000.00
docs/physics/integration.md (ref, held)227113.14%0.180.230.270.000.000.000.000.000.000.000.000.23
docs/physics/interpolation.md (ref, held)54711.30%0.000.000.000.000.000.000.000.000.000.000.000.00
docs/physics/log-readings.md (ref, held)2398816.610%0.250.120.490.170.000.010.010.000.000.000.020.33
docs/physics/magnetic.md (ref, held)223113.91%0.140.000.050.000.000.000.000.000.000.000.140.00
docs/physics/mass.md (ref, held)1002213.12%0.200.030.080.060.000.000.000.000.000.000.090.36
docs/physics/metrics.md (ref, held)656014.83%0.040.190.140.040.000.020.000.000.000.000.020.13
docs/physics/motor.md (ref, held)726415.07%0.280.180.420.060.000.000.000.000.000.000.050.27
docs/physics/moving-mass.md (ref, held)248813.40%0.090.050.000.090.000.000.000.000.000.000.090.65
docs/physics/quadrature.md (ref, held)49411.30%0.000.000.000.000.000.000.000.000.000.000.000.00
docs/physics/recovery.md (ref, held)1372414.52%0.220.210.090.100.000.010.010.000.000.000.060.15
docs/physics/released-mass.md (ref, held)279813.80%0.040.040.000.000.000.000.000.000.000.000.150.43
docs/physics/shapes.md (ref, held)201413.00%0.200.000.000.000.000.000.000.000.000.000.000.20
docs/physics/smoother.md (ref, held)246215.76%0.170.130.370.050.000.000.000.000.000.000.090.74
docs/physics/staging.md (ref, held)720114.30%0.460.240.000.200.000.020.000.000.000.000.060.10
docs/physics/synthetic-flights.md (ref, held)458915.22%0.400.090.110.050.000.000.000.000.000.000.000.24
docs/physics/turbulence.md (ref, held)129211.30%0.310.000.000.080.000.000.000.000.000.000.000.24
docs/physics/wind.md (ref, held)299214.70%0.370.070.000.040.000.000.000.000.000.000.310.27
docs/pick-a-motor.md (held)167114.13%0.000.000.180.120.000.000.000.000.001.140.48
docs/plan.md (held)107610.40%0.000.280.000.100.000.000.000.000.000.000.56
docs/python.md (held)503514.53%0.060.000.160.000.000.000.000.000.000.420.70
docs/reading-a-flight-log.md (held)398915.28%0.360.000.480.260.000.000.000.000.000.330.66
docs/recording-a-trajectory.md (held)82114.00%0.000.000.000.000.000.000.000.000.000.000.74
docs/releasing.md (held)259514.20%0.270.000.000.080.000.000.000.000.000.350.74
docs/sensitivity.md (held)226814.81%0.270.000.050.140.000.000.000.000.000.580.67
docs/simulator-compared.md (held)262813.16%0.000.000.350.080.000.000.000.040.000.160.69
docs/simulator-tour.md (held)160114.13%0.440.000.190.070.000.000.000.000.000.320.50
docs/soundings.md (held)506914.31%0.180.000.040.080.000.000.000.000.000.020.87
docs/stability-for-certification.md (held)207514.62%0.000.000.100.250.000.000.000.000.000.630.39
docs/stability-in-flight.md (held)183815.33%0.220.000.170.110.000.000.000.060.000.000.98
docs/start-here.md (held)909416.89%0.190.040.500.080.000.020.000.060.000.350.61
docs/the-builder.md (held)419612.91%0.200.000.030.000.000.000.000.050.000.460.58
docs/the-simulator.md (held)83115.56%0.000.000.370.000.000.000.000.130.000.851.09
docs/trusting-a-simulation.md (held)170115.45%0.000.000.300.180.000.000.000.000.000.060.95
docs/voice-report.md (held)15314.10%0.000.000.000.000.000.000.000.000.000.000.00
docs/weather.md (held)201613.11%0.000.000.050.000.000.000.000.000.000.300.85
docs/when-fins-flutter.md (held)176314.81%0.230.000.060.120.000.000.000.060.000.180.63
docs/writing.md (held)1287315.67%0.460.210.430.140.000.020.000.020.010.090.89
docs/your-own-logger.md (held)241014.61%0.000.000.050.090.000.000.000.000.000.420.67
docs/your-own-rocket.md (held)451814.71%0.360.000.050.090.000.000.000.000.000.380.69
crates/hpr-cli/src/ (ref, held)98629.91%0.000.000.090.210.020.000.000.000.000.000.200.51
crates/hpr/src/ (ref, held)6157.10%0.000.000.000.000.000.000.000.000.000.000.000.98
crates/hpr-sim/src/ (ref, held)391913.03%0.000.000.210.520.030.000.000.000.000.000.000.80
crates/hpr-io/src/ (ref, held)60169.61%0.000.000.040.170.020.000.000.000.000.040.000.24
crates/hpr-motor/src/ (ref, held)13968.82%0.000.000.150.080.000.000.000.000.000.000.080.58
crates/hpr-design/src/ (ref, held)268310.11%0.000.000.080.040.000.000.000.000.000.000.000.45
crates/hpr-aero/src/ (ref, held)16157.70%0.000.000.000.000.000.070.000.000.000.000.000.44
crates/hpr-core/src/ (ref, held)2416.10%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-format/src/ (ref, held)5389.80%0.000.000.000.190.000.000.000.000.000.000.002.42
crates/hpr-atmos/src/ (ref, held)2444.30%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-net/src/ (ref, held)9677.50%0.000.000.000.000.000.000.000.000.000.000.000.32
crates/hpr-flightdata/src/ (ref, held)2914411.71%0.000.000.040.140.020.000.000.000.000.000.001.44
crates/hpr-analysis/src/ (ref, held)4495.20%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-forensics/src/ (ref, held)3835.70%0.000.270.000.000.000.000.000.000.000.000.002.88
crates/hpr-py/src/ (ref, held)69810.32%0.000.000.150.000.000.000.000.000.000.000.001.44
crates/hpr-aero/src/lib.rs (ref, held)49416.00%0.000.000.000.000.000.000.000.000.000.000.410.21
crates/hpr-analysis/src/lib.rs (ref, held)19413.00%0.000.000.000.000.000.000.000.000.000.000.000.52
crates/hpr-atmos/src/lib.rs (ref, held)11911.90%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-cli/src/lib.rs (ref, held)20418.60%0.000.000.000.000.000.000.000.000.000.000.000.99
crates/hpr-core/src/lib.rs (ref, held)8216.40%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-design/src/lib.rs (ref, held)14711.40%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-ffi/src/lib.rs (ref, held)266.50%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-flightdata/src/lib.rs (ref, held)85312.62%0.000.000.120.000.000.000.000.000.000.000.000.71
crates/hpr-forensics/src/lib.rs (ref, held)11713.00%0.000.000.000.000.000.000.000.000.000.000.000.86
crates/hpr-format/src/lib.rs (ref, held)32815.70%0.000.000.000.000.000.000.000.000.000.000.000.92
crates/hpr-io/src/lib.rs (ref, held)13710.60%0.000.000.000.000.000.000.000.000.000.000.000.73
crates/hpr-motor/src/lib.rs (ref, held)11013.80%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-net/src/lib.rs (ref, held)21212.50%0.000.000.000.000.000.000.000.000.000.000.000.95
crates/hpr-py/src/lib.rs (ref, held)36716.70%0.000.000.000.000.000.000.000.000.000.000.000.28
crates/hpr-sim/src/lib.rs (ref, held)37216.25%0.000.000.270.000.000.000.000.000.000.000.000.00
crates/hpr-validate/src/lib.rs (ref, held)22013.80%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr-wasm/src/lib.rs (ref, held)235.80%0.000.000.000.000.000.000.000.000.000.000.000.00
crates/hpr/src/lib.rs (ref, held)44910.70%0.000.000.000.000.000.000.000.000.000.000.000.23

What the commands say

Each src/ page above is a crate’s message census (ADR-292, the plan for the program’s words): its #[error] texts and the other string literals in its code that read as prose, less its tests and its markup. A forwarded error passes on another’s text. A literal with a placeholder is read in pieces, and the census doesn’t see what fills it. cargo xtask voice --messages prints every line it read.

CrateFilesLiterals read#[error] textsForwardedWith a placeholder
crates/hpr-cli/src/2889900465
crates/hpr/src/98430819
crates/hpr-sim/src/2326017953
crates/hpr-io/src/31582452333
crates/hpr-motor/src/151477081
crates/hpr-design/src/132496364
crates/hpr-aero/src/151896348
crates/hpr-core/src/144012011
crates/hpr-format/src/3537041
crates/hpr-atmos/src/957704
crates/hpr-net/src/14120521095
crates/hpr-flightdata/src/5620331521331
crates/hpr-analysis/src/178710317
crates/hpr-forensics/src/166811317
crates/hpr-py/src/6640044
FusionSpace HPRVersion 0.1.0Issued 2026-11-21In preparationAbout HPR Sim