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
56 stars 41 forks source link

Exporting some enums #89

Closed ekuinox closed 1 year ago

ekuinox commented 1 year ago

Changes

I Added below enums exporting.


I think it would be better to rename NavigationStatus to GnsNavigationStatus to clarify the difference from RmcNavigationStatus. However, this would be a destructive change, so I would like your opinion. I think it would be better to export the names of both NavigationStatus and GnsNavigationStatus, but encourage NavigationStatus to use #[deprecated] to use GnsNavigationStatus.

elpiel commented 1 year ago

Hmmm... I would instead leave them in their respective module making them public and keep the same names. If someone wants to rename the import they can do it. Long names are never something I personally prefer.

We can do breaking changes, it's not a big deal, especially bumping minor versions.

And Thank you for the PR!

ekuinox commented 1 year ago

Changed to make all modules under nmea::sentences public. Also, some SentenceType parsing was missing, so it has been added.

codecov[bot] commented 1 year ago

Codecov Report

Patch coverage: 33.33% and project coverage change: -0.04 :warning:

Comparison is base (2d30392) 80.35% compared to head (f465474) 80.31%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #89 +/- ## ========================================== - Coverage 80.35% 80.31% -0.04% ========================================== Files 33 33 Lines 1196 1199 +3 ========================================== + Hits 961 963 +2 - Misses 235 236 +1 ``` | [Impacted Files](https://app.codecov.io/gh/AeroRust/nmea/pull/89?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AeroRust) | Coverage Δ | | |---|---|---| | [src/sentences/mod.rs](https://app.codecov.io/gh/AeroRust/nmea/pull/89?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AeroRust#diff-c3JjL3NlbnRlbmNlcy9tb2QucnM=) | `0.00% <ø> (ø)` | | | [src/parse.rs](https://app.codecov.io/gh/AeroRust/nmea/pull/89?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AeroRust#diff-c3JjL3BhcnNlLnJz) | `73.62% <33.33%> (-0.24%)` | :arrow_down: |

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