Skip to content

Commit fcb4b7f

Browse files
authored
Removed use of the "-rs" name from the comments (#76)
1 parent afa71aa commit fcb4b7f

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

swiftnav/src/lib.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
88
// EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
99
// WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
10-
//! `swiftnav-rs` is a library that implements GNSS utility functions to perform
11-
//! position estimations. The data used by `swiftnav-rs` typically comes from GNSS
12-
//! receiver chips as raw observation and ephemeris data. `swiftnav-rs` is more of
10+
//! `swiftnav` is a library that implements GNSS utility functions to perform
11+
//! position estimations. The data used by `swiftnav` typically comes from GNSS
12+
//! receiver chips as raw observation and ephemeris data. `swiftnav` is more of
1313
//! a "bring your own algorithm" library, it provides a bunch of functionality that
1414
//! is useful when processing raw GNSS data, but it provides only limited position
1515
//! estimation capabilities. Each module encompasses a single set of functionality,
@@ -23,13 +23,13 @@
2323
//! transmission and the delays of the messages the receiver is able to determine
2424
//! the location of itself in relation to the satellites.
2525
//!
26-
//! `swiftnav-rs` does not provide any functionality for communicating with
26+
//! `swiftnav` does not provide any functionality for communicating with
2727
//! receivers made by Swift Navigation, or any manufacturer.
2828
//! [libsbp](https://github.com/swift-nav/libsbp) is the library to use if you
2929
//! want to communicate with receivers using Swift Binary Protocol (SBP).
3030
//!
3131
//! ## Time
32-
//! Time is a very important aspect of GNSS. `swiftnav-rs` defaults to representing
32+
//! Time is a very important aspect of GNSS. `swiftnav` defaults to representing
3333
//! all times as GPS times. It provides the ability to manipulate GPS time stamps,
3434
//! as well as means to convert a GPS time stamp into various other time bases
3535
//! (GLONASS time, UTC, MJD).
@@ -47,7 +47,7 @@
4747
//!
4848
//! ## Troposphere and Ionosphere
4949
//! Two major sources of signal error in GNSS are the troposphere and ionosphere.
50-
//! `swiftnav-rs` provides the ability to decode and use the broadcast Klobuchar
50+
//! `swiftnav` provides the ability to decode and use the broadcast Klobuchar
5151
//! ionosphere model. An implementation of the UNM3m troposphere model is also
5252
//! provided.
5353
//!

swiftnav/src/time.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,24 @@
77
//! seconds since the beginning of the week. In GPS time the week begins at
88
//! midnight on Sunday.
99
//!
10-
//! [`GpsTime`] is the primary representation used in swiftnav-rs. Other time bases
10+
//! [`GpsTime`] is the primary representation used in swiftnav. Other time bases
1111
//! 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
15-
//! swiftnav-rs.
15+
//! swiftnav.
1616
//!
1717
//! # ⚠️ 🦘 ⏱ ⚠️ - Leap Seconds
1818
//! UTC time occasinally adds additional seconds to keep it synchronized with the
1919
//! slowly changing spin of the earth. This complicates time keeping, so most
2020
//! GNSS time bases ignore leap seconds and thus slowly grow out of sync with UTC.
2121
//! This is fine when dealing with GNSS data, but it's common that people want time
2222
//! to be represented as a UTC time since that's what people are more familiar with.
23-
//! swiftnav-rs provides ways to convert to and from UTC synchronized time bases
23+
//! swiftnav provides ways to convert to and from UTC synchronized time bases
2424
//! and is able to correctly compensate for leap seconds in two ways.
2525
//!
2626
//! The first is by using the UTC conversion parameters broadcast by GNSS systems
27-
//! that receivers can decode. [`UtcParams`] is how swiftnav-rs represents this
27+
//! that receivers can decode. [`UtcParams`] is how swiftnav represents this
2828
//! information, and [`UtcParams::decode()`] is provided for decoding the raw GPS
2929
//! navigation subframe with this information. This is the prefered method since it
3030
//! is usually available when processing raw GNSS data and ensures that the right

0 commit comments

Comments
 (0)