Skip to content

Commit 6d76f12

Browse files
authored
Merge pull request #326 from JuliaRobotics/hotfix/1Q20/318
re-add keyword in saveDFG with deprecation
2 parents 87abfee + b331f12 commit 6d76f12

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

src/FileDFG/services/FileDFG.jl

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
$(SIGNATURES)
44
Save a DFG to a folder. Will create/overwrite folder if it exists.
55
6+
DevNotes:
7+
- TODO remove `compress` kwarg.
8+
69
# Example
710
```julia
811
using DistributedFactorGraphs, IncrementalInference
@@ -14,8 +17,12 @@ v1 = addVariable!(dfg, :a, ContinuousScalar, labels = [:POSE], solvable=0)
1417
saveDFG(dfg, "/tmp/saveDFG.tar.gz")
1518
```
1619
"""
17-
function saveDFG(dfg::AbstractDFG, folder::String)
20+
function saveDFG(dfg::AbstractDFG, folder::String; compress::Symbol=:null)
1821

22+
if compress != :null
23+
@warn "saveDFG keyword args are deprecated, and folders will be tarred as standard in current and future versions."
24+
end
25+
1926
# TODO: Deprecate the folder functionality in v0.6.1
2027

2128
# Clean up save path if a file is specified

0 commit comments

Comments
 (0)