Merge pull request #960 from JuliaRobotics/23Q1/enh/blobentry

switching to Blob and BlobEntry

Author: dehann

src/DataBlobs/services/AbstractDataEntries.jl

@@ -147,7 +147,10 @@ end
 
 """
     $(SIGNATURES)
-List the data entries associated with a particular variable.
+List the blob entries associated with a particular variable.
+
+DevNotes
+- TODO rename to listBlobEntries (drop noun Data in lower level calls)
 """
 function listDataEntries(var::AbstractDFGVariable)
     collect(keys(var.dataDict))

src/DataBlobs/services/DataEntryBlob.jl

@@ -69,6 +69,9 @@ Related
 [`updateDataEntry!`](@ref)
 
 $(METHODLIST)
+
+DevNotes
+- TODO TBD update verb on data since data blobs and entries are restricted to immutable only.
 """
 function updateData! end
 

src/services/AbstractDFG.jl

@@ -466,20 +466,19 @@ end
 ##------------------------------------------------------------------------------
 """
     $(SIGNATURES)
-Get a list of IDs of the DFGVariables in the DFG.
+Get a list of labels of the DFGVariables in the graph.
 Optionally specify a label regular expression to retrieves a subset of the variables.
 Tags is a list of any tags that a node must have (at least one match).
 
-NOtes
+Notes
 - Returns `::Vector{Symbol}`
 
 Example
 ```julia
 listVariables(dfg, r"l", tags=[:APRILTAG;])
 ```
 
-Related:
-- ls
+See also: [`ls`](@ref)
 """
 function listVariables( dfg::AbstractDFG, 
                         regexFilter::Union{Nothing, Regex}=nothing; 
@@ -502,7 +501,7 @@ end
 
 """
     $(SIGNATURES)
-Get a list of the IDs (labels) of the DFGFactors in the DFG.
+Get a list of the labels of the DFGFactors in the DFG.
 Optionally specify a label regular expression to retrieves a subset of the factors.
 """
 function listFactors(dfg::G, regexFilter::Union{Nothing, Regex}=nothing; tags::Vector{Symbol}=Symbol[], solvable::Int=0)::Vector{Symbol} where G <: AbstractDFG