Update docstring

JuliaGeometry · Oct 16, 2024 · 81b8282 · 81b8282
1 parent e975838
commit 81b8282
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 6 deletions.
diff --git a/src/transforms/morphological.jl b/src/transforms/morphological.jl
@@ -5,9 +5,12 @@
 """
     Morphological(fun; boundary=false)
 
-Morphological transform given by a function `fun`
+Morphological transform given by a function `fun`,
 that maps the coordinates of a geometry or a domain
 to new coordinates (`coords -> newcoords`).
+Optionally, the transform samples the `boundary` of polytopes,
+if this option is `true`, to handle distortions
+that occur in manifold conversions.
 
 # Examples
 
@@ -16,7 +19,7 @@ ball = Ball((0, 0), 1)
 ball |> Morphological(c -> Cartesian(c.x + c.y, c.y, c.x - c.y))
 
 triangle = Triangle(latlon(0, 0), latlon(0, 45), latlon(45, 0))
-triangle |> Morphological(c -> LatLonAlt(c.lon, c.lat, 0.0m), boundary=true)
+triangle |> Morphological(c -> LatLonAlt(c.lat, c.lon, 0.0m), boundary=true)
 ```
 """
 struct Morphological{Boundary,F<:Function} <: CoordinateTransform

diff --git a/src/transforms/proj.jl b/src/transforms/proj.jl
@@ -8,6 +8,9 @@
 
 Convert the coordinates of geometry or domain to a given
 coordinate reference system `CRS` or EPSG/ESRI `code`.
+Optionally, the transform samples the `boundary` of polytopes,
+if this option is `true`, to handle distortions
+that occur in manifold conversions.
 
 ## Examples
 

diff --git a/test/sets.jl b/test/sets.jl
@@ -30,22 +30,24 @@
   q = Quadrangle(latlon(0, 0), latlon(0, 1), latlon(1, 1), latlon(1, 0)) |> Proj(WebMercator)
   geoms = [s, t, q]
   gset = GeometrySet(geoms)
+  @test eltype(gset) <: Polytope
   @test crs(gset) <: LatLon
   gset = GeometrySet(g for g in geoms)
+  @test eltype(gset) <: Polytope
   @test crs(gset) <: LatLon
   geoms = [t, s, q]
   gset = GeometrySet(geoms)
-  @test eltype(gset) <: TransformedGeometry
+  @test eltype(gset) <: Polytope
   @test crs(gset) <: PlateCarree
   gset = GeometrySet(g for g in geoms)
-  @test eltype(gset) <: TransformedGeometry
+  @test eltype(gset) <: Polytope
   @test crs(gset) <: PlateCarree
   geoms = [q, s, t]
   gset = GeometrySet(geoms)
-  @test eltype(gset) <: TransformedGeometry
+  @test eltype(gset) <: Polytope
   @test crs(gset) <: WebMercator
   gset = GeometrySet(g for g in geoms)
-  @test eltype(gset) <: TransformedGeometry
+  @test eltype(gset) <: Polytope
   @test crs(gset) <: WebMercator
 
   # conversion