fix functions and standardise iterator docstrings

Author: rafaqz

src/defaults.jl

@@ -50,7 +50,7 @@ getpolygon(p::AbstractMultiPolygonTrait, geom) = getgeom(p, geom)
 getpolygon(p::AbstractMultiPolygonTrait, geom, i) = getgeom(p, geom, i)
 getring(g::AbstractMultiPolygonTrait, geom) = (r for r in getring(p) for p in getpolygon(geom))
 getpoint(g::AbstractMultiPolygonTrait, geom) = (p for p in getpoint(r) for r in getring(geom))
-nring(p::AbstractPolygonTrait, geom) = sum(nring(p) for p in getpolygon(p))
+nring(p::AbstractMultiPolygonTrait, geom) = sum(nring(p) for p in getpolygon(p))
 
 ## Surface
 npatch(p::AbstractPolyHedralSurfaceTrait, geom)::Integer = ngeom(p, geom)

src/interface.jl

@@ -84,7 +84,7 @@ Note that this is only valid for individual [`AbstractPoint`]s.
 """
 getcoord(geom, i::Integer) = getcoord(geomtype(geom), geom, i)
 """
-    getcoord(geom) -> Iterator
+    getcoord(geom) -> iterator
 """
 getcoord(geom) = getcoord(geomtype(geom), geom)
 
@@ -104,8 +104,11 @@ Return the `i`th Point in given `geom`.
 Note that this is only valid for [`AbstractCurve`](@ref)s and [`AbstractMultiPoint`](@ref)s.
 """
 getpoint(geom, i::Integer) = getpoint(geomtype(geom), geom, i)
+
 """
-    getpoint(geom) -> Iterator
+    getpoint(geom) -> iterator
+
+Returns an iterator over all points in `geom`.
 """
 getpoint(geom) = getpoint(geomtype(geom), geom)
 
@@ -200,17 +203,20 @@ nring(geom) = nring(geomtype(geom), geom)
     getring(geom, [i::Integer]) -> Int
 
 Return the `i`th ring for a given `geom`.
-Without the `i` argument, an iterator over all rings is returned.
 
-Note that this is only valid for [`AbstractPolygon`](@ref)s and
-[`AbstractMultiPolygon`](@ref)s in single-argument form.
+Note that this is only valid for [`AbstractPolygon`](@ref)s.
 """
 getring(geom, i::Integer) = getring(geomtype(geom), geom, i)
+
 """
-    getring(geom) -> Iterator
+    getring(geom) -> iterator
+
+Returns an iterator over all rings in `geom`.
+
+Note that this is only valid for [`AbstractPolygon`](@ref)s and
+[`AbstractMultiPolygon`](@ref)s in single-argument form.
 """
 getring(geom) = getring(geomtype(geom), geom)
-getring(geom, i) = getring(geomtype(geom), geom, i)
 
 """
     getexterior(geom) -> Curve
@@ -220,23 +226,27 @@ Note that this is only valid for [`AbstractPolygon`](@ref)s.
 """
 getexterior(geom) = getexterior(geomtype(geom), geom)
 
-
 """
     nhole(geom) -> Integer
 
 Returns the number of holes for this given `geom`.
 Note that this is only valid for [`AbstractPolygon`](@ref)s.
 """
 nhole(geom)::Integer = nhole(geomtype(geom), geom)
+
 """
     gethole(geom, i::Integer) -> Curve
 
 Returns the `i`th interior ring for this given `geom`.
 Note that this is only valid for [`AbstractPolygon`](@ref)s.
 """
 gethole(geom, i::Integer) = gethole(geomtype(geom), geom, i)
+
 """
-    gethole(geom) -> Iterator
+    gethole(geom) -> iterator
+
+Returns an iterator over all holes in `geom`.
+Note that this is only valid for [`AbstractPolygon`](@ref)s.
 """
 gethole(geom) = gethole(geomtype(geom), geom)
 
@@ -256,8 +266,12 @@ Returns the `i`th patch for the given `geom`.
 Note that this is only valid for [`AbstractPolyHedralSurface`](@ref)s.
 """
 getpatch(geom, i::Integer) = getpatch(geomtype(geom), geom, i)
+
 """
-    getpatch(geom) -> Iterator
+    getpatch(geom) -> iterator
+
+Returns an iterator over all patches in `geom`.
+Note that this is only valid for [`AbstractPolyHedralSurface`](@ref)s.
 """
 getpatch(geom) = getpatch(geomtype(geom), geom)
 
@@ -282,8 +296,11 @@ ngeom(geom) = ngeom(geomtype(geom), geom)
 Returns the `i`th geometry for the given `geom`.
 """
 getgeom(geom, i::Integer) = getgeom(geomtype(geom), geom, i)
+
 """
-    getgeom(geom) -> Iterator
+    getgeom(geom) -> iterator
+
+Returns an iterator over all geometry components in `geom`.
 """
 getgeom(geom) = getgeom(geomtype(geom), geom)
 
@@ -303,8 +320,12 @@ Returns the `i`th linestring for the given `geom`.
 Note that this is only valid for [`AbstractMultiLineString`](@ref)s.
 """
 getlinestring(geom, i::Integer) = getlinestring(geomtype(geom), geom, i)
+
 """
-    getlinestring(geom) -> Iterator
+    getlinestring(geom, i::Integer) -> iterator
+
+Returns an iterator over all linestrings in a geometry.
+Note that this is only valid for [`AbstractMultiLineString`](@ref)s.
 """
 getlinestring(geom) = getlinestring(geomtype(geom), geom)
 
@@ -318,30 +339,38 @@ Note that this is only valid for [`AbstractMultiPolygon`](@ref)s.
 npolygon(geom) = npolygon(geomtype(geom), geom)
 
 """
-    getpolygon(geom, [i::Integer]) -> AbstractCurve
+    getpolygon(geom) -> AbstractCurve
 
 Returns the `i`th polygon for the given `geom`.
-Where no `i` index is passed, an iterator over all polygons is returned.
 Note that this is only valid for [`AbstractMultiPolygon`](@ref)s.
 """
 getpolygon(geom) = getpolygon(geomtype(geom), geom)
-getpolygon(geom, i::Integer) = getpolygon(geomtype(geom), geom, i)
+
 """
-    getpolygon(geom) -> Iterator
+    getpolygon(geom) -> AbstractCurve
+
+Returns an iterator over all polygons in a geometry.
+Note that this is only valid for [`AbstractMultiPolygon`](@ref)s.
 """
-getpolygon(geom) = getpolygon(geomtype(geom), geom)
+getpolygon(geom, i::Integer) = getpolygon(geomtype(geom), geom, i)
 
 """
-    getring(geom, i::Integer) -> iterable
+    getring(geom, i::Integer) -> AbstractCurve
 
 A specific ring `i` in a polygon or multipolygon (exterior and holes).
-Where no `i` index is passed, an iterator over all rings is returned.
+Note that this is only valid for [`AbstractPolygon`](@ref)s and
+[`AbstractMultiPolygon`](@ref)s.
+"""
+getring(geom, i::Integer) = getring(geomtype(geom), geom, i)
+
+"""
+    getring(geom) -> iterable
 
+Returns an iterator over all rings in a geometry.
 Note that this is only valid for [`AbstractPolygon`](@ref)s and
 [`AbstractMultiPolygon`](@ref)s.
 """
 getring(geom) = getring(geomtype(geom), geom)
-getring(geom, i::Integer) = getring(geomtype(geom), geom, i)
 
 # Other methods
 """
@@ -471,7 +500,7 @@ union(a, b) = union(geomtype(a), geomtype(b), a, b)
 
 # Spatial analysis
 """
-    distance(a, b) -> Number
+3   distance(a, b) -> Number
 
 Returns the shortest distance between `a` with `b`.
 """