Skip to content

Commit f4c22d1

Browse files
fkastnerDatseris
andauthored
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>
1 parent 953888e commit f4c22d1

File tree

4 files changed

+7
-5
lines changed

4 files changed

+7
-5
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# 2.4.1
2+
* `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)
13
# 2.4.0
24
* Add the macro version of `produce_or_load` to enable tagging with the calling source file and line.
35
# 2.3.0

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "DrWatson"
22
uuid = "634d3b9d-ee7a-5ddf-bec9-22491ea816e1"
33
repo = "https://github.com/JuliaDynamics/DrWatson.jl.git"
4-
version = "2.4.0"
4+
version = "2.4.1"
55

66
[deps]
77
Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"

src/naming.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,9 @@ savename(c::Any, suffix::String; kwargs...) =
8484
savename(prefix::String, c::Any; kwargs...) = savename(prefix, c, ""; kwargs...)
8585
function savename(prefix::String, c, suffix::String;
8686
allowedtypes = default_allowed(c),
87-
accesses = allaccess(c), ignores = allignore(c), digits = 3,
87+
accesses = allaccess(c), ignores = allignore(c), digits::Union{Int,Nothing} = nothing,
8888
connector = "_", expand::Vector{String} = default_expand(c),
89-
sigdigits::Union{Int,Nothing}=nothing,
89+
sigdigits::Union{Int,Nothing} = 3,
9090
val_to_string = nothing,
9191
sort = true, equals = "=")
9292

@@ -97,7 +97,7 @@ function savename(prefix::String, c, suffix::String;
9797
`savename` (e.g. `datadir("path", "to", "folder", savename("prefix", data))`).
9898
"""
9999
end
100-
digits = sigdigits === nothing ? digits : nothing
100+
sigdigits = digits === nothing ? sigdigits : nothing
101101
val2string = val_to_string === nothing ? (val -> valtostring(val, digits, sigdigits)) : val_to_string
102102
# Here take care of extra prefix besides default
103103
dpre = default_prefix(c)

test/naming_tests.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ di = @dict a c d
112112
@test savename(di,sigdigits=3) == "a=1.23e-7_c=1_d=test"
113113
@test savename(di,sigdigits=2) == "a=1.2e-7_c=1_d=test"
114114
@test savename(di,sigdigits=1) == "a=1e-7_c=1_d=test"
115-
@test savename(di) == "a=0.0_c=1_d=test"
115+
@test savename(di) == "a=1.23e-7_c=1_d=test" # default is sigdigits=3
116116

117117
sn = savename(di,sigdigits=4)
118118
_,parsed,_ = parse_savename(sn)

0 commit comments

Comments
 (0)