From 26eab17e8dee63c3d1ad4d99986a4a75c3c2cf9b Mon Sep 17 00:00:00 2001 From: Joseph Angelo Date: Mon, 4 Oct 2021 22:41:04 -0700 Subject: [PATCH] Removed use of the "-rs" name from the comments --- swiftnav/src/lib.rs | 12 ++++++------ swiftnav/src/time.rs | 8 ++++---- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/swiftnav/src/lib.rs b/swiftnav/src/lib.rs index 9d9ef8e..07de1b8 100644 --- a/swiftnav/src/lib.rs +++ b/swiftnav/src/lib.rs @@ -7,9 +7,9 @@ // THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, // EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED // WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE. -//! `swiftnav-rs` is a library that implements GNSS utility functions to perform -//! position estimations. The data used by `swiftnav-rs` typically comes from GNSS -//! receiver chips as raw observation and ephemeris data. `swiftnav-rs` is more of +//! `swiftnav` is a library that implements GNSS utility functions to perform +//! position estimations. The data used by `swiftnav` typically comes from GNSS +//! receiver chips as raw observation and ephemeris data. `swiftnav` is more of //! a "bring your own algorithm" library, it provides a bunch of functionality that //! is useful when processing raw GNSS data, but it provides only limited position //! estimation capabilities. Each module encompasses a single set of functionality, @@ -23,13 +23,13 @@ //! transmission and the delays of the messages the receiver is able to determine //! the location of itself in relation to the satellites. //! -//! `swiftnav-rs` does not provide any functionality for communicating with +//! `swiftnav` does not provide any functionality for communicating with //! receivers made by Swift Navigation, or any manufacturer. //! [libsbp](https://github.com/swift-nav/libsbp) is the library to use if you //! want to communicate with receivers using Swift Binary Protocol (SBP). //! //! ## Time -//! Time is a very important aspect of GNSS. `swiftnav-rs` defaults to representing +//! Time is a very important aspect of GNSS. `swiftnav` defaults to representing //! all times as GPS times. It provides the ability to manipulate GPS time stamps, //! as well as means to convert a GPS time stamp into various other time bases //! (GLONASS time, UTC, MJD). @@ -47,7 +47,7 @@ //! //! ## Troposphere and Ionosphere //! Two major sources of signal error in GNSS are the troposphere and ionosphere. -//! `swiftnav-rs` provides the ability to decode and use the broadcast Klobuchar +//! `swiftnav` provides the ability to decode and use the broadcast Klobuchar //! ionosphere model. An implementation of the UNM3m troposphere model is also //! provided. //! diff --git a/swiftnav/src/time.rs b/swiftnav/src/time.rs index 6cd24c4..d44e38a 100644 --- a/swiftnav/src/time.rs +++ b/swiftnav/src/time.rs @@ -7,12 +7,12 @@ //! seconds since the beginning of the week. In GPS time the week begins at //! midnight on Sunday. //! -//! [`GpsTime`] is the primary representation used in swiftnav-rs. Other time bases +//! [`GpsTime`] is the primary representation used in swiftnav. Other time bases //! are available, such as [`UtcTime`], [`GalTime`], [`BdsTime`], and [`GloTime`] //! along with conversions for all of these to and from [`GpsTime`]. //! Not all functionality is available in these other representations, so it's //! intended that all times are to converted to [`GpsTime`] before use with -//! swiftnav-rs. +//! swiftnav. //! //! # ⚠️ 🦘 ⏱ ⚠️ - Leap Seconds //! UTC time occasinally adds additional seconds to keep it synchronized with the @@ -20,11 +20,11 @@ //! GNSS time bases ignore leap seconds and thus slowly grow out of sync with UTC. //! This is fine when dealing with GNSS data, but it's common that people want time //! to be represented as a UTC time since that's what people are more familiar with. -//! swiftnav-rs provides ways to convert to and from UTC synchronized time bases +//! swiftnav provides ways to convert to and from UTC synchronized time bases //! and is able to correctly compensate for leap seconds in two ways. //! //! The first is by using the UTC conversion parameters broadcast by GNSS systems -//! that receivers can decode. [`UtcParams`] is how swiftnav-rs represents this +//! that receivers can decode. [`UtcParams`] is how swiftnav represents this //! information, and [`UtcParams::decode()`] is provided for decoding the raw GPS //! navigation subframe with this information. This is the prefered method since it //! is usually available when processing raw GNSS data and ensures that the right