Merge pull request #1069 from JuliaRobotics/master

release v0.23.7-rc1
JuliaRobotics · Jan 23, 2024 · 101cfb1 · 101cfb1
2 parents cf5062f + cc9b34b
commit 101cfb1
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 5 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,6 +1,6 @@
 name = "DistributedFactorGraphs"
 uuid = "b5cc3c7e-6572-11e9-2517-99fb8daf2f04"
-version = "0.23.6"
+version = "0.23.7"
 
 [deps]
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"

diff --git a/docs/src/GraphData.md b/docs/src/GraphData.md
@@ -84,9 +84,9 @@ Solved graphs contain packed parametric estimates for the variables, which are k
 
 For each PPE structure, there are accessors for getting individual values:
 
-- [`getMaxPPE`](@ref)
-- [`getMeanPPE`](@ref)
-- [`getSuggestedPPE`](@ref)
+- [`getPPEMax`](@ref)
+- [`getPPEMean`](@ref)
+- [`getPPESuggested`](@ref)
 
 
 Related functions for getting, adding/updating, and deleting PPE structures:

diff --git a/src/services/DFGVariable.jl b/src/services/DFGVariable.jl
@@ -475,6 +475,12 @@ Return full dictionary of PPEs in a variable, recommended to rather use CRUD: [`
 """
 getVariablePPEDict(vari::VariableDataLevel1) = getPPEDict(vari)
 
+"""
+    getVariablePPE(::DFGVariable)
+    getVariablePPE(::VariableNodeData)
+
+Get the Parametric Point Estimate of the given variable.
+"""
 getVariablePPE(args...) = getPPE(args...)
 
 ##------------------------------------------------------------------------------
@@ -956,7 +962,7 @@ Notes
 - Defaults on keywords `solveKey` and `method`
 
 Related
-[`getMeanPPE`](@ref), [`getMaxPPE`](@ref), [`updatePPE!`](@ref), getKDEMean, getKDEFit, getPPEs, getVariablePPEs
+[`getPPEMean`](@ref), [`getPPEMax`](@ref), [`updatePPE!`](@ref), `mean(BeliefType)`
 """
 function getPPE(v::DFGVariable, ppekey::Symbol = :default)
     !haskey(v.ppeDict, ppekey) &&