AeroRust / nmea

NMEA 0183 - for communication between marine electronics such as echo sounder, sonars, anemometer, gyrocompass, autopilot, GNSS receivers and many other types of instruments. Defined and controlled by the National Marine Electronics Association (NMEA)
https://crates.io/crates/nmea
Other
57 stars 41 forks source link

Update/Fix `RMC` docs #57

Closed Turbo87 closed 1 year ago

Turbo87 commented 1 year ago

There was a broken link in the doc comment for the RmcData struct and while I was at it I also added some other missing information in the comment :)

codecov[bot] commented 1 year ago

Codecov Report

Base: 76.80% // Head: 76.80% // No change to project coverage :thumbsup:

Coverage data is based on head (9970296) compared to base (a12f552). Patch has no changes to coverable lines.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #57 +/- ## ======================================= Coverage 76.80% 76.80% ======================================= Files 20 20 Lines 776 776 ======================================= Hits 596 596 Misses 180 180 ``` | [Impacted Files](https://codecov.io/gh/AeroRust/nmea/pull/57?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AeroRust) | Coverage Δ | | |---|---|---| | [src/sentences/rmc.rs](https://codecov.io/gh/AeroRust/nmea/pull/57/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AeroRust#diff-c3JjL3NlbnRlbmNlcy9ybWMucnM=) | `89.28% <ø> (ø)` | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AeroRust). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AeroRust)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

elpiel commented 1 year ago

Great catch and thank you for contributing to the project again! I don't think we support all the options though... This is something you can improve on for this sentence.

If you're interested I've opened #60 issue for the additional parsing