diff -r df971c81282e -r bcb508479948 src/main.rs --- a/src/main.rs Thu Dec 01 23:46:09 2022 +0200 +++ b/src/main.rs Thu Dec 01 23:37:14 2022 +0200 @@ -1,15 +1,16 @@ // The main documentation is in the README. -#![doc = include_str!("../README.md")] +// We need to uglify it in build.rs because rustdoc is stuck in the past. +#![doc = include_str!(concat!(env!("OUT_DIR"), "/README_uglified.md"))] // We use unicode. We would like to use much more of it than Rust allows. // Live with it. Embrace it. #![allow(uncommon_codepoints)] #![allow(mixed_script_confusables)] #![allow(confusable_idents)] -// Linear operators may be writtten e.g. as `opA` for a resemblance -// to mathematical convention. +// Linear operators may be written e.g. as `opA`, to keep the capital letters of mathematical +// convention while referring to the type (trait) of the operator as `A`. #![allow(non_snake_case)] -// We need the drain filter for inertial prune +// We need the drain filter for inertial prune. #![feature(drain_filter)] use clap::Parser;