update defaults for keyword arguments of savename (#285)

* update defaults for keyword arguments of `savename`

* update Changelog

* bump version in Project.toml

* Update CHANGELOG.md

* fix digits not overriding sigdigits in savename

Co-authored-by: George Datseris <datseris.george@gmail.com>

Author: fkastner

CHANGELOG.md

@@ -1,3 +1,5 @@
+# 2.4.1
+* `savename`'s default options now have `sigdigits = 3` instead of `digits = 3` as stated in the documentation string. This was supposed to happen already since 2.0 but did not because of a bug. (#284)
 # 2.4.0
 * Add the macro version of `produce_or_load` to enable tagging with the calling source file and line.
 # 2.3.0

Project.toml

@@ -1,7 +1,7 @@
 name = "DrWatson"
 uuid = "634d3b9d-ee7a-5ddf-bec9-22491ea816e1"
 repo = "https://github.com/JuliaDynamics/DrWatson.jl.git"
-version = "2.4.0"
+version = "2.4.1"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"

src/naming.jl

@@ -84,9 +84,9 @@ savename(c::Any, suffix::String; kwargs...) =
 savename(prefix::String, c::Any; kwargs...) = savename(prefix, c, ""; kwargs...)
 function savename(prefix::String, c, suffix::String;
                   allowedtypes = default_allowed(c),
-                  accesses = allaccess(c), ignores = allignore(c), digits = 3,
+                  accesses = allaccess(c), ignores = allignore(c), digits::Union{Int,Nothing} = nothing,
                   connector = "_", expand::Vector{String} = default_expand(c),
-                  sigdigits::Union{Int,Nothing}=nothing,
+                  sigdigits::Union{Int,Nothing} = 3,
                   val_to_string = nothing,
                   sort = true, equals = "=")
 
@@ -97,7 +97,7 @@ function savename(prefix::String, c, suffix::String;
             `savename` (e.g. `datadir("path", "to", "folder", savename("prefix", data))`).
         """
     end
-    digits = sigdigits === nothing ? digits : nothing
+    sigdigits = digits === nothing ? sigdigits : nothing
     val2string = val_to_string === nothing ? (val -> valtostring(val, digits, sigdigits)) : val_to_string
     # Here take care of extra prefix besides default
     dpre = default_prefix(c)

test/naming_tests.jl

@@ -112,7 +112,7 @@ di = @dict a c d
 @test savename(di,sigdigits=3) == "a=1.23e-7_c=1_d=test"
 @test savename(di,sigdigits=2) == "a=1.2e-7_c=1_d=test"
 @test savename(di,sigdigits=1) == "a=1e-7_c=1_d=test"
-@test savename(di) == "a=0.0_c=1_d=test"
+@test savename(di) == "a=1.23e-7_c=1_d=test" # default is sigdigits=3
 
 sn = savename(di,sigdigits=4)
 _,parsed,_ = parse_savename(sn)