Mercurial > repos > non-riemannian-opt / file diff

--- a/src/main.rs	Fri Dec 06 14:27:14 2024 -0500
+++ b/src/main.rs	Fri Dec 06 14:57:11 2024 -0500
@@ -1,6 +1,5 @@
-/*!
-Optimisation on non-Riemannian manifolds.
-*/
+// Optimisation on non-Riemannian manifolds.
+#![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.
@@ -140,7 +139,7 @@
 }
 
 
-/// A simple test on the cube
+/// A simple test on a [`Cylinder`].
 fn simple_cylinder_test(dir : &str) -> DynError {
     let π = f64::PI;
 
@@ -202,7 +201,7 @@
 }
 
 
-/// Runs [forward_backward] and saves the results.
+/// Runs [`forward_backward`] and saves the results.
 pub fn run_and_save<F, G, M, I>(
     dir : &str,
     name : &str,