Skip to content

Conversation

jbangelo
Copy link
Collaborator

Cleaned up the formatting and spelling in the README. Also added some more introductory information to the crate docs. swiftnav-rs is never going to be a "plug and play" positioning library, but I felt like it could do with a little bit of a prelude explaining what functionality it provides and the type of developer that might be interested in using it.

… more introductory information to the cratedocs
@jbangelo jbangelo requested review from jayvdb and silverjam July 30, 2021 01:55
Comment on lines +34 to +35
//! as well as means to convert a GPS time stamp into various other time bases
//! (GLONASS time, UTC, MJD).
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as well as means to convert a GPS time stamp into various other time bases
(GLONASS time, UTC, MJD).

Strictly speaking, this isn't the case yet. I've been slowly working on exposing this conversion functionality. I hope a little lie isn't too much of an issue while I finish the wrapper.

@jbangelo jbangelo force-pushed the jbangelo/intro-docs branch from a671212 to a328016 Compare July 30, 2021 18:23
@jbangelo
Copy link
Collaborator Author

I tried using the new example of how to import the README.md as a doc comment, but at the moment we've got some non-rust code in the README. I think it's valuable to keep that information about how to publish releases, so I'm going to leave the bulk of the new introduction in lib.rs for now.

@jbangelo jbangelo merged commit a3bb3e9 into master Jul 30, 2021
@jbangelo jbangelo deleted the jbangelo/intro-docs branch July 30, 2021 21:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants