Some Cleanup

Author: Sov-trotter

src/metadata.jl

@@ -6,31 +6,43 @@ end
 Feature(x; kwargs...) = Feature(x, values(kwargs))
 
 #can change names?
+"""
+Frees the Feature out of metadata
+i.e. returns and array of geometries
+"""
 function metafree(F::Feature)
     getproperty(F, :data)
 end
 metafree(x::AbstractVector{<: Feature}) = [getproperty(i, :data) for i in x]
 
+"""
+Returns the metadata of a Feature
+"""
 function meta(x::Feature)
     getfield(x, :rest)
 end
 meta(x::AbstractVector{<: Feature}) = [getproperty(i, :rest) for i in x]
 
+# helper methods
 Base.getproperty(f::Feature, s::Symbol) = s == :data ? getfield(f, 1) : s == :rest ? getfield(f, 2) : getproperty(getfield(f, 2), s)
 Base.propertynames(f::Feature) = (:data, propertynames(f.rest)...)
-
 getnamestypes(::Type{Feature{T, Names, Types}}) where {T, Names, Types} = (T, Names, Types) 
 
-function StructArrays.staticschema(::Type{F}) where {F<:Feature} #explicitly give the "schema" of the object to StructArrays
+# explicitly give the "schema" of the object to StructArrays
+function StructArrays.staticschema(::Type{F}) where {F<:Feature} 
     T, names, types = getnamestypes(F)
     NamedTuple{(:data, names...), Base.tuple_type_cons(T, types)}
 end
 
-function StructArrays.createinstance(::Type{F}, x, args...) where {F<:Feature} #generate an instance of Feature type 
+# generate an instance of Feature type
+function StructArrays.createinstance(::Type{F}, x, args...) where {F<:Feature}  
      T , names, types = getnamestypes(F)
      Feature(x, NamedTuple{names, types}(args))
 end
 
+"""
+Accepts an Array/iterator of Features and put it into a StructArray 
+"""
 function structarray(iter)
     cols = Tables.columntable(iter)
     structarray(first(cols), Base.tail(cols)) 

test/runtests.jl

@@ -207,7 +207,7 @@ using GeometryBasics: attributes
         @test GeometryBasics.metafree(poly) == polys[1]
         @test GeometryBasics.metafree(multipoly) == multipol
         @test GeometryBasics.meta(meta_p) == (boundingbox = GeometryBasics.HyperRectangle{2,Int64}([0, 0], [2, 2]),)
-        @test GeometryBasics.meta(poly) == (name = "cMlR", value = 0.0, category = true)
+        @test GeometryBasics.meta(poly) == (name = pnames[1], value = 0.0, category = bin[1])
         @test GeometryBasics.meta(multipoly) == (name = pnames, value = numbers, category = bin)    
     end