Skip to content

Commit 3ce7c95

Browse files
committed
a few missing docstrings
1 parent 3f43ec1 commit 3ce7c95

File tree

3 files changed

+22
-2
lines changed

3 files changed

+22
-2
lines changed

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name = "DistributedFactorGraphs"
22
uuid = "b5cc3c7e-6572-11e9-2517-99fb8daf2f04"
3-
version = "0.23.5"
3+
version = "0.23.6"
44

55
[deps]
66
Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"

src/Common.jl

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,5 +124,16 @@ end
124124
## Additional Downstream dispatches
125125
## =================================
126126

127+
"""
128+
$SIGNATURES
129+
130+
Default non-parametric graph solution.
131+
"""
127132
function solveGraph! end
133+
134+
"""
135+
$SIGNATURES
136+
137+
Standard parametric graph solution (Experimental).
138+
"""
128139
function solveGraphParametric! end

src/FileDFG/services/FileDFG.jl

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,8 @@ loadDFG!(dfg, "/tmp/savedgraph.tar.gz")
9191
# Use the DFG as you do normally.
9292
ls(dfg)
9393
```
94+
95+
See also: [`loadDFG`](@ref), [`saveDFG`](@ref)
9496
"""
9597
function loadDFG!(
9698
dfgLoadInto::AbstractDFG,
@@ -218,6 +220,13 @@ function loadDFG!(
218220
return dfgLoadInto
219221
end
220222

223+
"""
224+
$SIGNATURES
225+
226+
Convenience graph loader into a default `LocalDFG`.
227+
228+
See also: [`loadDFG!`](@ref), [`saveDFG`](@ref)
229+
"""
221230
function loadDFG(file::AbstractString)
222231

223232
# add if doesn't have .tar.gz extension
@@ -238,7 +247,7 @@ function loadDFG(file::AbstractString)
238247
fgPacked = JSON3.read(jstr, GraphsDFGs.PackedGraphsDFG)
239248
dfg = GraphsDFGs.unpackDFGMetadata(fgPacked)
240249

241-
@debug "DFG.loadDFG! is deleting a temp folder created during unzip, $loaddir"
250+
@debug "DFG.loadDFG is deleting a temp folder created during unzip, $loaddir"
242251
# cleanup temporary folder
243252
Base.rm(loaddir; recursive = true, force = true)
244253

0 commit comments

Comments
 (0)