Merge pull request #1815 from JuliaRobotics/24Q1/docs/fixdocstrings

fix broken outdated docstrings
JuliaRobotics · Jan 22, 2024 · b5c3fbc · b5c3fbc
2 parents 3fee901 + 703865f
commit b5c3fbc
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 8 deletions.
diff --git a/src/parametric/services/ConsolidateParametricRelatives.jl b/src/parametric/services/ConsolidateParametricRelatives.jl
@@ -18,7 +18,7 @@ DevNotes
 
 Related:
 
-[`getMeasurementParametric`](@ref), [`approxConv`](@ref), [`MutablePose2Pose2Gaussian`](@ref)
+[`getMeasurementParametric`](@ref), [`approxConvBelief`](@ref), [`MutablePose2Pose2Gaussian`](@ref)
 """
 function solveFactorParameteric(
   dfg::AbstractDFG,

diff --git a/src/parametric/services/ParametricManopt.jl b/src/parametric/services/ParametricManopt.jl
@@ -562,7 +562,11 @@ function autoinitParametric!(
 end
 
 
-##
+"""
+    $SIGNATURES
+
+Batch parametric graph solve using Riemannian Levenberg Marquardt.
+"""
 solveGraphParametric(args...; kwargs...) = solve_RLM(args...; kwargs...)
 
 function DFG.solveGraphParametric!(

diff --git a/src/services/CalcFactor.jl b/src/services/CalcFactor.jl
@@ -118,7 +118,7 @@ residual = calcFactorResidual(fg, :x1x2f1, [1.0], [0.0], [0.0])
 
 Related
 
-[`calcFactorResidualTemporary`](@ref), [`_evalFactorTemporary!`](@ref), [`evalFactor`](@ref), [`approxConv`](@ref)
+[`calcFactorResidualTemporary`](@ref), [`_evalFactorTemporary!`](@ref), [`evalFactor`](@ref), [`approxConvBelief`](@ref)
 """
 function calcFactorResidual(
   dfgfct::DFGFactor,
@@ -147,7 +147,7 @@ residual = calcFactorResidualTemporary(Pose2Pose2(...), (RoME.Pose2,RoME.Pose2),
 
 Related
 
-[`calcFactorResidual`](@ref), [`CalcResidual`](@ref), [`_evalFactorTemporary!`](@ref), [`approxConv`](@ref), [`_buildGraphByFactorAndTypes!`](@ref)
+[`calcFactorResidual`](@ref), [`CalcResidual`](@ref), [`_evalFactorTemporary!`](@ref), [`approxConvBelief`](@ref), [`_buildGraphByFactorAndTypes!`](@ref)
 """
 function calcFactorResidualTemporary(
   fct::AbstractRelative,

diff --git a/src/services/DeconvUtils.jl b/src/services/DeconvUtils.jl
@@ -168,12 +168,12 @@ Generalized deconvolution to find the predicted measurement values of the factor
 Inverse solve of predicted noise value and returns tuple of (newly predicted, and known "measured" noise) values.
 
 Notes
-- Opposite operation contained in `approxConv`.
+- Opposite operation contained in `approxConvBelief`.
 - For more notes see [`solveFactorMeasurements`](@ref).
 
 Related
 
-[`approxConv`](@ref), `deconvSolveKey`
+[`approxConvBelief`](@ref), `deconvSolveKey`
 """
 function approxDeconv(
   dfg::AbstractDFG,

diff --git a/src/services/GraphProductOperations.jl b/src/services/GraphProductOperations.jl
@@ -11,7 +11,7 @@ Notes
 
 Related
 
-[`approxConv`](@ref), [`proposalbeliefs!`](@ref), [`AMP.manifoldProduct`](@ref)
+[`approxConvBelief`](@ref), [`proposalbeliefs!`](@ref), [`AMP.manifoldProduct`](@ref)
 """
 function propagateBelief(
   dfg::AbstractDFG,

diff --git a/src/services/TetherUtils.jl b/src/services/TetherUtils.jl
@@ -114,7 +114,7 @@ DevNotes
 
 Related:
 
-[`approxConv`](@ref), [`solveFactorParameteric`](@ref), `RoME.MutablePose2Pose2Gaussian`
+[`approxConvBelief`](@ref), [`solveFactorParameteric`](@ref), `RoME.MutablePose2Pose2Gaussian`
 """
 function accumulateFactorMeans(
   dfg::AbstractDFG,