add label_for, doc changes

Author: bramtayl

src/MetaGraphsNext.jl

@@ -324,7 +324,7 @@ copy(g::T) where {T<:MetaGraph} = deepcopy(g)
 """
     code_for(meta::MetaGraph, vertex_label)
 
-Find the code for associated with a vertex with `vertex_label`. This can be useful to pass
+Find the code associated with a `vertex_label`. This can be useful to pass
 to methods inherited from `LightGraphs`. Note, however, that vertex codes could be
 reassigned after vertex deletion.
 
@@ -347,6 +347,30 @@ function code_for(meta::MetaGraph, vertex_label)
 end
 export code_for
 
+"""
+    label_for(meta::MetaGraph, vertex_code)
+
+Find the label associated with a `vertex_code`. This can be useful to interpret the results of methods
+inherited from `LightGraphs`. Note, however, that vertex codes could be reassigned after vertex deletion.
+
+```jldoctest
+julia> using MetaGraphsNext
+
+julia> using LightGraphs: Graph
+
+julia> meta = MetaGraph(Graph());
+
+julia> meta[:a] = nothing
+
+julia> label_for(meta, 1)
+:a
+```
+"""
+function label_for(meta::MetaGraph, vertex_code)
+    meta.metaindex[vertex_code]
+end
+export label_for
+
 include("metadigraph.jl")
 include("overrides.jl")
 include("persistence.jl")

src/metagraph.jl

@@ -74,20 +74,20 @@ julia> using LightGraphs
 
 julia> using MetaGraphsNext
 
-julia> colors = MetaGraph(Graph(), VertexMeta = Int, EdgeMeta = Symbol, gprops = "special")
-Meta graph based on a {0, 0} undirected simple Int64 graph with vertices indexed by Symbol(s), Int64(s) vertex metadata, Symbol(s) edge metadata, "special" as graph metadata, and default weight 1.0
+julia> colors = MetaGraph(Graph(), VertexMeta = String, EdgeMeta = Symbol, gprops = "special")
+Meta graph based on a {0, 0} undirected simple Int64 graph with vertices indexed by Symbol(s), String(s) vertex metadata, Symbol(s) edge metadata, "special" as graph metadata, and default weight 1.0
 ```
 
 Use `setindex!` to add a new vertex with the given metadata. If a vertex with the given
 index does not exist, it will be created automatically; otherwise, `setindex!` will modify
 the metadata for the existing vertex.
 
 ```jldoctest example
-julia> colors[:red] = 1;
+julia> colors[:red] = "warm";
 
-julia> colors[:yellow] = 2;
+julia> colors[:yellow] = "warm";
 
-julia> colors[:blue] = 3;
+julia> colors[:blue] = "cool";
 ```
 
 You can access and change the metadata using indexing: zero arguments for graph metadata,
@@ -97,10 +97,10 @@ one label for vertex metadata, and two labels for edge metadata.
 julia> colors[]
 "special"
 
-julia> colors[:blue] = 4;
+julia> colors[:blue] = "very cool";
 
 julia> colors[:blue]
-4
+"very cool"
 
 julia> colors[:red, :yellow] = :orange;
 
@@ -154,7 +154,7 @@ julia> nv(zero(colors))
 julia> ne(copy(colors))
 0
 
-julia> add_vertex!(colors, :white, 4)
+julia> add_vertex!(colors, :white, "neutral")
 true
 
 julia> add_edge!(colors, 1, 3, :pink)