Skip to content

Commit fd5fce5

Browse files
authored
release cleanup (#75)
* rename chrono-support feature to chrono * escape braces in doc comments/fix some links
1 parent 9c60d47 commit fd5fce5

File tree

4 files changed

+17
-20
lines changed

4 files changed

+17
-20
lines changed

swiftnav/Cargo.toml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,3 @@ license = "LGPL-3.0"
1111
[dependencies]
1212
chrono = { version = "0.4", optional = true }
1313
swiftnav-sys = { version = "^0.6.2-alpha.0", path = "../swiftnav-sys/" }
14-
15-
[features]
16-
chrono-support = ["chrono"]

swiftnav/src/coords.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010
//! Coordinates and conversions
1111
//!
1212
//! These four primary coordinates types are defined:
13-
//! * [LLH](LLH) - Geodetic coordinates, Latitude Lontitude Height
14-
//! * [ECEF](ECEF) - Cartesian coordinates, Earth Centered, Earth Fixed
15-
//! * NED - Relative direction coordinates, North East Down
16-
//! * [AzEl](AzEl) - Relative direction coordinates, Azimith Elevation
13+
//! * [LLHDegrees]/[LLHRadians] - Geodetic coordinates, Latitude Lontitude Height
14+
//! * [ECEF] - Cartesian coordinates, Earth Centered, Earth Fixed
15+
//! * [NED] - Relative direction coordinates, North East Down
16+
//! * [AzimuthElevation] - Relative direction coordinates, Azimith Elevation
1717
//!
1818
//! --------
1919
//! Conversion from geodetic coordinates latitude, longitude and height

swiftnav/src/ionosphere.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,13 +100,13 @@ impl Ionosphere {
100100
/// Calculate ionospheric delay using Klobuchar model.
101101
///
102102
/// \param t_gps GPS time at which to calculate the ionospheric delay
103-
/// \param lat_u Latitude of the receiver [rad]
104-
/// \param lon_u Longitude of the receiver [rad]
105-
/// \param a Azimuth of the satellite, clockwise positive from North [rad]
106-
/// \param e Elevation of the satellite [rad]
103+
/// \param lat_u Latitude of the receiver \[rad\]
104+
/// \param lon_u Longitude of the receiver \[rad\]
105+
/// \param a Azimuth of the satellite, clockwise positive from North \[rad\]
106+
/// \param e Elevation of the satellite \[rad\]
107107
/// \param i Ionosphere parameters struct from GPS NAV data
108108
///
109-
/// \return Ionospheric delay distance for GPS L1 frequency [m]
109+
/// \return Ionospheric delay distance for GPS L1 frequency \[m\]
110110
pub fn calc_delay(&self, t: &GpsTime, lat_u: f64, lon_u: f64, a: f64, e: f64) -> f64 {
111111
unsafe { swiftnav_sys::calc_ionosphere(t.c_ptr(), lat_u, lon_u, a, e, &self.0) }
112112
}

swiftnav/src/time.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
//! midnight on Sunday.
99
//!
1010
//! [`GpsTime`] is the primary representation used in swiftnav-rs. Other time bases
11-
//! are available, such as [`Utctime`], [`GalTime`], [`BdsTime`], and [`GloTime`]
11+
//! are available, such as [`UtcTime`], [`GalTime`], [`BdsTime`], and [`GloTime`]
1212
//! along with conversions for all of these to and from [`GpsTime`].
1313
//! Not all functionality is available in these other representations, so it's
1414
//! intended that all times are to converted to [`GpsTime`] before use with
@@ -603,15 +603,15 @@ impl UtcParams {
603603
})
604604
}
605605

606-
/// Modulo 1 sec offset from GPS to UTC [s]
606+
/// Modulo 1 sec offset from GPS to UTC \[s\]
607607
pub fn a0(&self) -> f64 {
608608
self.0.a0
609609
}
610-
/// Drift of time offset from GPS to UTC [s/s]
610+
/// Drift of time offset from GPS to UTC \[s/s\]
611611
pub fn a1(&self) -> f64 {
612612
self.0.a1
613613
}
614-
/// Drift rate correction from GPS to UTC [s/s]
614+
/// Drift rate correction from GPS to UTC \[s/s\]
615615
pub fn a2(&self) -> f64 {
616616
self.0.a2
617617
}
@@ -623,11 +623,11 @@ impl UtcParams {
623623
pub fn t_lse(&self) -> GpsTime {
624624
GpsTime(self.0.t_lse)
625625
}
626-
/// Leap second delta from GPS to UTC before LS event [s]
626+
/// Leap second delta from GPS to UTC before LS event \[s\]
627627
pub fn dt_ls(&self) -> i8 {
628628
self.0.dt_ls
629629
}
630-
/// Leap second delta from GPS to UTC after LS event [s]
630+
/// Leap second delta from GPS to UTC after LS event \[s\]
631631
pub fn dt_lsf(&self) -> i8 {
632632
self.0.dt_lsf
633633
}
@@ -742,7 +742,7 @@ impl From<MJD> for UtcTime {
742742
}
743743
}
744744

745-
#[cfg(feature = "chrono-support")]
745+
#[cfg(feature = "chrono")]
746746
impl From<UtcTime> for chrono::DateTime<chrono::offset::Utc> {
747747
fn from(utc: UtcTime) -> chrono::DateTime<chrono::offset::Utc> {
748748
use chrono::prelude::*;
@@ -766,7 +766,7 @@ impl From<UtcTime> for chrono::DateTime<chrono::offset::Utc> {
766766
}
767767
}
768768

769-
#[cfg(feature = "chrono-support")]
769+
#[cfg(feature = "chrono")]
770770
impl<Tz: chrono::offset::TimeZone> From<chrono::DateTime<Tz>> for UtcTime {
771771
fn from(chrono: chrono::DateTime<Tz>) -> UtcTime {
772772
use chrono::prelude::*;

0 commit comments

Comments
 (0)