add note to parsing

jillesvangurp · Nov 17, 2023 · 13b97da · 13b97da
1 parent be4a13d
commit 13b97da
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/commonMain/kotlin/com/jillesvangurp/geo/mgrs.kt b/src/commonMain/kotlin/com/jillesvangurp/geo/mgrs.kt
@@ -221,6 +221,8 @@ private val mgrsRegex = "([0-9]+)\\s*([A-Z])\\s*([A-Z])\\s*([A-Z])\\s*([0-9]{1,5
 
 /**
  * Parses a mgrs or usng string to [MgrsCoordinate]. Returns the coordinate or null if none was found.
+ *
+ * Note the string may contain other things, this implementation simply looks for the first matching coordinate.
  */
 fun String.parseMgrs(): MgrsCoordinate? {
     return mgrsRegex.find(this)?.let { match ->