Merge pull request #1816 from JuliaRobotics/24Q1/docs/docstringfixes

various doc string fixes
JuliaRobotics · Jan 23, 2024 · 85cf101 · 85cf101
2 parents b5c3fbc + ac91724
commit 85cf101
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 9 deletions.
diff --git a/src/parametric/services/ConsolidateParametricRelatives.jl b/src/parametric/services/ConsolidateParametricRelatives.jl
@@ -16,9 +16,7 @@ DevNotes
 - TODO ensure type stability, likely returning types `Any` at this time.
 - TODO MeanMaxPPE currently stored as coordinates, complicating fast calculation.
 
-Related:
-
-[`getMeasurementParametric`](@ref), [`approxConvBelief`](@ref), [`MutablePose2Pose2Gaussian`](@ref)
+Related: [`getMeasurementParametric`](@ref), [`approxConvBelief`](@ref), [`MutablePose2Pose2Gaussian`](@ref)
 """
 function solveFactorParameteric(
   dfg::AbstractDFG,

diff --git a/src/services/ApproxConv.jl b/src/services/ApproxConv.jl
@@ -70,7 +70,7 @@ DevNotes
 
 Related
 
-[`approxDeconv`](@ref), `LocalDFG.findShortestPathDijkstra`, [`evalFactor`](@ref)
+[`approxDeconv`](@ref), `findShortestPathDijkstra`
 """
 function approxConvBelief(
   dfg::AbstractDFG,

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), [`approxConvBelief`](@ref)
+[`calcFactorResidualTemporary`](@ref), [`_evalFactorTemporary!`](@ref), [`approxConvBelief`](@ref)
 """
 function calcFactorResidual(
   dfgfct::DFGFactor,

diff --git a/src/services/EvalFactor.jl b/src/services/EvalFactor.jl
@@ -620,9 +620,7 @@ B = _evalFactorTemporary!(EuclidDistance, (ContinuousScalar, ContinuousScalar),
 # should return `B = 10`
 ```
 
-Related
-
-[`evalFactor`](@ref), [`calcFactorResidual`](@ref), [`testFactorResidualBinary`](@ref), [`solveFactorParameteric`](@ref), [`approxConvBelief`](@ref)
+See also:  [`calcFactorResidual`](@ref), [`testFactorResidualBinary`](@ref), [`solveFactorParameteric`](@ref), [`approxConvBelief`](@ref)
 """
 function _evalFactorTemporary!(
   fct::AbstractFactor,

diff --git a/src/services/FGOSUtils.jl b/src/services/FGOSUtils.jl
@@ -232,7 +232,7 @@ DevNotes
 
 Related
 
-[`getVariablePPE`](@ref), [`setVariablePosteriorEstimates!`](@ref), [`getVariablePPE!`](@ref), [`setPPE!`](@ref)
+[`getPPE`](@ref), [`setPPE!`](@ref), [`getVariablePPE`](@ref)
 """
 function calcPPE(
   var::DFGVariable,