Updates to docstrings

GeoRegionsEcosystem · Sep 25, 2024 · f6c07d7 · f6c07d7
1 parent e9757e5
commit f6c07d7
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 7 deletions.
diff --git a/docs/src/api/addreadrm.md b/docs/src/api/addreadrm.md
@@ -2,9 +2,9 @@
 
 ```@docs
 GeoRegion(
-        geoID :: AbstractString;
-        path  :: AbstractString = homedir()
-    ) -> geo :: GeoRegion
+    geoID :: AbstractString;
+    path  :: AbstractString = homedir()
+)
 ```
 
 ```@docs

diff --git a/docs/src/basics/properties/isin.md b/docs/src/basics/properties/isin.md
@@ -126,9 +126,21 @@ And we see that this is indeed the case.
 
 ```@docs
 in(
-    Point  :: Point2{<:Real},
-    geo    :: RectRegion;
+    :: Point2{<:Real},
+    :: GeoRegion;
+    :: Real = 0,
+    :: Real = 0,
+    :: Bool = false
+)
+in(
+    :: GeoRegion,
+    :: RectRegion;
+    :: Bool = false
+)
+in(
+    cgeo  :: GeoRegion,
+    geo   :: Union{TiltRegion,PolyRegion};
+    n     :: Int = 100,
+    throw :: Bool = false
 )
-in(::GeoRegion,::RectRegion)
-in(::GeoRegion,::PolyRegion)
 ```