From 3e1347ffb342ce443e8b20248881b070464d9be0 Mon Sep 17 00:00:00 2001 From: Louis Date: Sat, 28 Sep 2024 16:59:25 +0200 Subject: [PATCH] escapes the units in doc so that they're not interpreted as links --- src/lib.rs | 70 +++++++++++++++++++++++++++--------------------------- 1 file changed, 35 insertions(+), 35 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index ed7fc79..4d1c9ee 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -96,27 +96,27 @@ impl MagneticModel { /// /// # Arguments /// - /// * `h` - The height above the WGS84 ellipsoid [metres] - /// * `phi` - The latitude [degrees] - /// * `lambda` - The longitude [degrees] - /// * `year` - The year [decimal] e.g. 2022.5 + /// * `h` - The height above the WGS84 ellipsoid \[metres\] + /// * `phi` - The latitude \[degrees\] + /// * `lambda` - The longitude \[degrees\] + /// * `year` - The year \[decimal\] e.g. 2022.5 /// /// # Returns /// - /// * `X` - The northward intensity [nT] - /// * `Y` - The eastward intensity [nT] - /// * `Z` - The downward intensity [nT] - /// * `H` - The horizontal intensity [nT] - /// * `F` - The total intensity [nT] - /// * `I` - The inclination [degrees] - /// * `D` - The declination [degrees] - /// * `X_dot` - The rate of change of the northward intensity [nT/year] - /// * `Y_dot` - The rate of change of the eastward intensity [nT/year] - /// * `Z_dot` - The rate of change of the downward intensity [nT/year] - /// * `H_dot` - The rate of change of the horizontal intensity [nT/year] - /// * `F_dot` - The rate of change of the total intensity [nT/year] - /// * `I_dot` - The rate of change of the inclination [degrees/year] - /// * `D_dot` - The rate of change of the declination [degrees/year] + /// * `X` - The northward intensity \[nT\] + /// * `Y` - The eastward intensity \[nT\] + /// * `Z` - The downward intensity \[nT\] + /// * `H` - The horizontal intensity \[nT\] + /// * `F` - The total intensity \[nT\] + /// * `I` - The inclination \[degrees\] + /// * `D` - The declination \[degrees\] + /// * `X_dot` - The rate of change of the northward intensity \[nT/year\] + /// * `Y_dot` - The rate of change of the eastward intensity \[nT/year\] + /// * `Z_dot` - The rate of change of the downward intensity \[nT/year\] + /// * `H_dot` - The rate of change of the horizontal intensity \[nT/year\] + /// * `F_dot` - The rate of change of the total intensity \[nT/year\] + /// * `I_dot` - The rate of change of the inclination \[degrees/year\] + /// * `D_dot` - The rate of change of the declination \[degrees/year\] /// /// # Note /// @@ -312,23 +312,23 @@ mod tests { /// /// * `year` - The year /// * `h` - The height above the WGS84 ellipsoid [km] - /// * `phi` - The latitude [degrees] - /// * `l` - The longitude [degrees] - /// * `expected_X` - The expected northward intensity [nT] - /// * `expected_Y` - The expected eastward intensity [nT] - /// * `expected_Z` - The expected downward intensity [nT] - /// * `expected_H` - The expected horizontal intensity [nT] - /// * `expected_F` - The expected total intensity [nT] - /// * `expected_I` - The expected inclination [degrees] - /// * `expected_D` - The expected declination [degrees] - /// * `expected_GV` - The expected grid variation [degrees] - /// * `expected_X_dot` - The expected rate of change of the northward intensity [nT/year] - /// * `expected_Y_dot` - The expected rate of change of the eastward intensity [nT/year] - /// * `expected_Z_dot` - The expected rate of change of the downward intensity [nT/year] - /// * `expected_H_dot` - The expected rate of change of the horizontal intensity [nT/year] - /// * `expected_F_dot` - The expected rate of change of the total intensity [nT/year] - /// * `expected_I_dot` - The expected rate of change of the inclination [degrees/year] - /// * `expected_D_dot` - The expected rate of change of the declination [degrees/year] + /// * `phi` - The latitude \[degrees\] + /// * `l` - The longitude \[degrees\] + /// * `expected_X` - The expected northward intensity \[nT\] + /// * `expected_Y` - The expected eastward intensity \[nT\] + /// * `expected_Z` - The expected downward intensity \[nT\] + /// * `expected_H` - The expected horizontal intensity \[nT\] + /// * `expected_F` - The expected total intensity \[nT\] + /// * `expected_I` - The expected inclination \[degrees\] + /// * `expected_D` - The expected declination \[degrees\] + /// * `expected_GV` - The expected grid variation \[degrees\] + /// * `expected_X_dot` - The expected rate of change of the northward intensity \[nT/year\] + /// * `expected_Y_dot` - The expected rate of change of the eastward intensity \[nT/year\] + /// * `expected_Z_dot` - The expected rate of change of the downward intensity \[nT/year\] + /// * `expected_H_dot` - The expected rate of change of the horizontal intensity \[nT/year\] + /// * `expected_F_dot` - The expected rate of change of the total intensity \[nT/year\] + /// * `expected_I_dot` - The expected rate of change of the inclination \[degrees/year\] + /// * `expected_D_dot` - The expected rate of change of the declination \[degrees/year\] /// /// # Note ///