Skip to content

Commit

Permalink
Field docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Affie committed Dec 10, 2019
1 parent 653242f commit 068a2fe
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 4 additions & 0 deletions src/entities/DFGFactor.jl
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,14 @@ end
"""
$(TYPEDEF)
Skeleton factor with essentials.
$(FIELDS)
"""
struct SkeletonDFGFactor <: AbstractDFGFactor
"Factor label, :x1f1, `label(factor)`"

This comment has been minimized.

Copy link
@dehann

dehann Dec 11, 2019

Member

this would become getLabel(factor), right? #232

This comment has been minimized.

Copy link
@dehann

dehann Dec 16, 2019

Member

yes the idea of doing docs like this is great!

label::Symbol
"Factor tags, [:FACTOR], `tags(factor)`"

This comment has been minimized.

Copy link
@dehann

dehann Dec 11, 2019

Member

similarly getTags(factor)

This comment has been minimized.

Copy link
@dehann

dehann Dec 16, 2019

Member

docs like this would be great!

tags::Vector{Symbol}
"The order of the variables associated with this factor."
_variableOrderSymbols::Vector{Symbol}
end

Expand Down
2 changes: 1 addition & 1 deletion src/services/AbstractDFG.jl
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,7 @@ function deleteVariableSolverData!(dfg::AbstractDFG, variablekey::Symbol, solvek
error("VariableNodeData '$(solvekey)' already exists")
end

vnd = pop!(var.solverDataDict, solvekey])
vnd = pop!(var.solverDataDict, solvekey)

return vnd
end
Expand Down

0 comments on commit 068a2fe

Please sign in to comment.