Changing removeGeoRegion to rmID

GeoRegionsEcosystem · Sep 6, 2024 · 580f22c · 580f22c
1 parent e7e1cff
commit 580f22c
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 6 deletions.
diff --git a/src/GeoRegions.jl b/src/GeoRegions.jl
@@ -15,8 +15,11 @@ export
         GeoRegion,
         RectRegion, PolyRegion, TiltRegion,
 
-        add, rm, overwrite,
-        isGeoRegion, isID, addGeoRegion, removeGeoRegion, 
+        isGeoRegion, isID, 
+        add, addGeoRegion,
+        rm, rmID,
+        overwrite,
+
         templateGeoRegions, readGeoRegions, addGeoRegions, resetGeoRegions,
         tableGeoRegions, tableRectRegions, tableTiltRegions, tablePolyRegions,
         isinGeoRegion, 

diff --git a/src/georegions/remove.jl b/src/georegions/remove.jl
@@ -19,16 +19,16 @@ rm(
     geo  :: GeoRegion;
     path :: AbstractString = geodir
 ) = if isGeoRegion(geo,path=path)
-    removeGeoRegion(geo.ID,path=path)
+    rmID(geo.ID,path=path)
 end
 
 """
-    removeGeoRegion(
+    rmID(
         geoID :: AbstractString;
         path  :: AbstractString = geodir
     )
 
-Creates the GeoRegion associated with the ID `geoID`.
+Removes any GeoRegion associated with the ID `geoID`. ID must be exact.
 
 Arguments
 =========
@@ -40,7 +40,7 @@ Keyword Arguments
 - `path` : The path where the list of custom GeoRegions will be retrieved from.
            Defaults to the `local` package variable `geodir`
 """
-function removeGeoRegion(
+function rmID(
     geoID :: AbstractString;
     path  :: AbstractString = geodir
 )