search

porcej / njord

A buoy to augment a GNSS data stream based on known Wifi AP locations.
MIT License
0 stars 0 forks source link

Documentation Error - Change `NMEA_PV` to `NMEA_RMC` #23

Closed porcej closed 5 months ago

porcej commented 5 months ago

Summary The current documentation and command line help functions incorrectly refer to the NMEA message type as NMEA_PV. The correct term should be NMEA_RMC.

Description In the README and the command line help functions, the message type NMEA_PV is mentioned. However, the correct NMEA message type is NMEA_RMC. This can cause confusion for users and needs to be updated to reflect the correct message type.

Steps to Reproduce

  1. Open the README file.
  2. Search for instances of NMEA_PV.
  3. Observe that NMEA_PV is mentioned instead of NMEA_RMC.

Similarly:

  1. Run the script with the --help option.
  2. Look at the description for message types.
  3. Observe that NMEA_PV is listed instead of NMEA_RMC.

Expected Behavior The README and the command line help functions should correctly reference NMEA_RMC instead of NMEA_PV.

Actual Behavior The documentation incorrectly references NMEA_PV.

Suggested Fix