Skip to content

Commit ac91724

Browse files
committed
various doc string fixes
1 parent b5c3fbc commit ac91724

File tree

5 files changed

+5
-9
lines changed

5 files changed

+5
-9
lines changed

src/parametric/services/ConsolidateParametricRelatives.jl

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,7 @@ DevNotes
1616
- TODO ensure type stability, likely returning types `Any` at this time.
1717
- TODO MeanMaxPPE currently stored as coordinates, complicating fast calculation.
1818
19-
Related:
20-
21-
[`getMeasurementParametric`](@ref), [`approxConvBelief`](@ref), [`MutablePose2Pose2Gaussian`](@ref)
19+
Related: [`getMeasurementParametric`](@ref), [`approxConvBelief`](@ref), [`MutablePose2Pose2Gaussian`](@ref)
2220
"""
2321
function solveFactorParameteric(
2422
dfg::AbstractDFG,

src/services/ApproxConv.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ DevNotes
7070
7171
Related
7272
73-
[`approxDeconv`](@ref), `LocalDFG.findShortestPathDijkstra`, [`evalFactor`](@ref)
73+
[`approxDeconv`](@ref), `findShortestPathDijkstra`
7474
"""
7575
function approxConvBelief(
7676
dfg::AbstractDFG,

src/services/CalcFactor.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ residual = calcFactorResidual(fg, :x1x2f1, [1.0], [0.0], [0.0])
118118
119119
Related
120120
121-
[`calcFactorResidualTemporary`](@ref), [`_evalFactorTemporary!`](@ref), [`evalFactor`](@ref), [`approxConvBelief`](@ref)
121+
[`calcFactorResidualTemporary`](@ref), [`_evalFactorTemporary!`](@ref), [`approxConvBelief`](@ref)
122122
"""
123123
function calcFactorResidual(
124124
dfgfct::DFGFactor,

src/services/EvalFactor.jl

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -620,9 +620,7 @@ B = _evalFactorTemporary!(EuclidDistance, (ContinuousScalar, ContinuousScalar),
620620
# should return `B = 10`
621621
```
622622
623-
Related
624-
625-
[`evalFactor`](@ref), [`calcFactorResidual`](@ref), [`testFactorResidualBinary`](@ref), [`solveFactorParameteric`](@ref), [`approxConvBelief`](@ref)
623+
See also: [`calcFactorResidual`](@ref), [`testFactorResidualBinary`](@ref), [`solveFactorParameteric`](@ref), [`approxConvBelief`](@ref)
626624
"""
627625
function _evalFactorTemporary!(
628626
fct::AbstractFactor,

src/services/FGOSUtils.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ DevNotes
232232
233233
Related
234234
235-
[`getVariablePPE`](@ref), [`setVariablePosteriorEstimates!`](@ref), [`getVariablePPE!`](@ref), [`setPPE!`](@ref)
235+
[`getPPE`](@ref), [`setPPE!`](@ref), [`getVariablePPE`](@ref)
236236
"""
237237
function calcPPE(
238238
var::DFGVariable,

0 commit comments

Comments
 (0)