Minor version bump and more metadata docs

Project.toml

@@ -1,7 +1,7 @@
 name = "FieldProperties"
 uuid = "127e4479-4c95-493a-afaa-609d38175b70"
 authors = ["zchristensen "]
-version = "0.4.1"
+version = "0.4.2"
 
 [deps]
 Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"

docs/src/metadata.md

@@ -1,6 +1,6 @@
 # Metadata
 
-TODO further document how to use metadata
+This section covers some basic types that are useful in constructing metadata for storing properties.
 
 ```@docs
 AbstractMetadata

src/metadata.jl

@@ -88,6 +88,56 @@ end
 
 Subtype of `AbstractMetadata` that provides `getproperty` syntax for accessing
 the values of a dictionary.
+
+## Examples
+```jldoctest
+julia> using FieldProperties
+
+julia> m = Metadata(; a = 1, b= 2)
+Metadata{Dict{Symbol,Any}} with 2 entries
+    a: 1
+    b: 2
+
+julia> getindex(m, :a)
+1
+
+julia> get(m, :a, 3)
+1
+
+julia> get!(m, :a, 3)
+1
+
+julia> m.a
+1
+
+julia> m[:a] = 2
+2
+
+julia> m.a
+2
+
+julia> m.b
+2
+
+julia> m.b = 3
+3
+
+julia> m.b
+3
+
+julia> m.name = "ridiculously long name that we don't want to print everytime the other properties are printed.";
+
+
+julia> m.suppress = (:name,)
+(:name,)
+
+julia> m
+Metadata{Dict{Symbol,Any}} with 4 entries
+    a: 2
+    b: 3
+    name: <suppressed>
+    suppress: (:name,)
+```
 """
 struct Metadata{D} <: AbstractMetadata{D}
     dictextension::D

test/metadata_tests.jl

@@ -6,6 +6,7 @@
     @test propertynames(m) == Tuple(keys(m)) == (:a, :b)
     @test getkey(m, :a, 1) == getkey(FieldProperties.dictextension(m), :a, 1)
 
+    #= TODO delete these once we know that they are still covered by docs
     @test getindex(m, :a) == 1
 
     @test get(m, :a, 3) == 1
@@ -19,6 +20,7 @@
     @test m.b == 2
     m.b = 3
     @test m.b == 3
+    =#
     @test length(m) == 2
     delete!(m, :a)
     @test !haskey(m, :a)