diff --git a/Project.toml b/Project.toml index 0ec64ee5..25cead9f 100644 --- a/Project.toml +++ b/Project.toml @@ -1,6 +1,6 @@ name = "FileIO" uuid = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549" -version = "1.6.1" +version = "1.6.2" [deps] Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f" diff --git a/src/types.jl b/src/types.jl index 5c6f5a93..a66640df 100644 --- a/src/types.jl +++ b/src/types.jl @@ -30,6 +30,10 @@ formatname(::Formatted{F}) where F<:DataFormat = formatname(F) `File{fmt}(filename)` indicates that `filename` is a file of known [`DataFormat`](@ref) `fmt`. For example, `File{format"PNG"}(filename)` would indicate a PNG file. + +!!! compat + `File{fmt}(filename)` requires FileIO 1.6 or higher. The deprecated syntax `File(fmt, filename)` works + on all FileIO 1.x releases. """ struct File{F<:DataFormat, Name} <: Formatted{F} filename::Name @@ -60,6 +64,10 @@ written in known format [`DataFormat`](@ref) `fmt`. For example, `Stream{format"PNG"}(io)` would indicate PNG format. If known, the optional `filename` argument can be used to improve error messages, etc. + +!!! compat + `Stream{fmt}(io, ...)` requires FileIO 1.6 or higher. The deprecated syntax `Stream(fmt, io, ...)` works + on all FileIO 1.x releases. """ struct Stream{F <: DataFormat, IOtype <: IO, Name} <: Formatted{F} io::IOtype