ConstellationVFR/geomag-wmm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

escapes the units in doc so that they're not interpreted as links

Browse source
This commit is contained in:
Louis 2024-09-28 16:59:25 +02:00
parent 7671a9abb5
commit 3e1347ffb3
1 changed files with 35 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

70
src/lib.rs
View file

@ -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
///