Skip to content
This repository has been archived by the owner on May 26, 2024. It is now read-only.

Changed rmc_isGxGGA to be called gga_isGxGGA for consistency #46

Merged
merged 1 commit into from
May 16, 2022

Conversation

bismurphy
Copy link
Contributor

Hi,

I've gone through all the code of this library and changed the rmc_isGxGGA functions to be called gga_isGxGGA. The RMC functions rmc_isGxRMC are untouched. I've just changed the prefix on the GGA functions to be gga rather than rmc, since they have nothing to do with RMC strings. For the sake of consistency and readability, I believe the GGA functions should be called gga. I suspect the fact that they start with rmc is a matter of old copy-pasted code sticking around and renaming them would aid the codebase in being more self consistent and comprehensible.

I realize this would make new versions fail to be backward compatible with old code which may use these rmc_isGxGGA functions. However, it seems unlikely that many users would be using these, since primarily the identification of commands is handled within the library itself, and given that I've already changed all the calls within the library to use the new "gga_" versions, this incompatibility should be minor.

Thank you for considering this pull request. If approved, I hope to also add other NMEA strings to this library, including GPGSV.

@codecov-commenter
Copy link

Codecov Report

Merging #46 (581c6f6) into master (ac48385) will not change coverage.
The diff coverage is 72.72%.

@@           Coverage Diff           @@
##           master      #46   +/-   ##
=======================================
  Coverage   91.35%   91.35%           
=======================================
  Files          10       10           
  Lines         370      370           
=======================================
  Hits          338      338           
  Misses         32       32           
Impacted Files Coverage Δ
src/nmea/GxRMC.cpp 97.72% <ø> (ø)
src/nmea/util/checksum.cpp 100.00% <ø> (ø)
src/nmea/util/common.cpp 100.00% <ø> (ø)
src/nmea/GxGGA.cpp 78.30% <25.00%> (ø)
src/ArduinoNmeaParser.cpp 97.95% <100.00%> (ø)
src/nmea/util/gga.cpp 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fd4c759...581c6f6. Read the comment docs.

Copy link
Member

@aentinger aentinger left a comment

Choose a reason for hiding this comment

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

Thank you very much for your PR @bismurphy 🚀 , this was indeed a copy-paste-error 🙇 .

@aentinger aentinger merged commit c7425bf into 107-systems:master May 16, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants