From 9836eab654ff294de74c3cf7f36d9820edb6c0b7 Mon Sep 17 00:00:00 2001 From: Jakob Nybo Nissen Date: Fri, 13 Oct 2023 16:22:10 +0200 Subject: [PATCH 1/2] Bump Documenter to 1.0 Also includes a series of fixes: * Remove CodecZlib from doc deps * Do not doctest using CodecZlib, a dep of this package * Document `transcode` --- .gitignore | 1 + docs/Project.toml | 3 +-- docs/make.jl | 1 - docs/src/reference.md | 4 ++-- src/stream.jl | 11 ++++------- src/transcode.jl | 1 - 6 files changed, 8 insertions(+), 13 deletions(-) diff --git a/.gitignore b/.gitignore index c0f96afd..c75514a5 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ *.jl.mem /Manifest.toml /docs/build/ +/docs/Manifest.toml diff --git a/docs/Project.toml b/docs/Project.toml index 3962130c..d0e7a230 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,7 +1,6 @@ [deps] -CodecZlib = "944b1d66-785c-5afd-91f1-9de20f533193" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" TranscodingStreams = "3bb67fe8-82b1-5028-8e26-92a6c54297fa" [compat] -Documenter = "~0.27" +Documenter = "1" diff --git a/docs/make.jl b/docs/make.jl index f77f37a9..59771ca5 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,6 +1,5 @@ using Documenter using TranscodingStreams -using CodecZlib makedocs( sitename="TranscodingStreams.jl", diff --git a/docs/src/reference.md b/docs/src/reference.md index f3ae50e6..0773c338 100644 --- a/docs/src/reference.md +++ b/docs/src/reference.md @@ -10,8 +10,8 @@ TranscodingStream ```@docs TranscodingStream(codec::Codec, stream::IO) -transcode(::Type{C}, args...) where {C<:Codec} -transcode(::Codec, ::Buffer, ::Union{Buffer,Nothing}) +transcode +TranscodingStreams.unsafe_transcode! TranscodingStreams.transcode! TranscodingStreams.TOKEN_END diff --git a/src/stream.jl b/src/stream.jl index 670649ec..5fd20c3a 100644 --- a/src/stream.jl +++ b/src/stream.jl @@ -97,17 +97,14 @@ Examples ```jldoctest julia> using TranscodingStreams -julia> using CodecZlib +julia> file = open(joinpath(dirname(dirname(pathof(TranscodingStreams))), "README.md")); -julia> file = open(joinpath(dirname(pathof(CodecZlib)), "..", "test", "abra.gz")); +julia> stream = NoopStream(file); -julia> stream = TranscodingStream(GzipDecompressor(), file); - -julia> String(read(stream)) -"abracadabra" +julia> readline(file) +"TranscodingStreams.jl" julia> close(stream) - ``` """ function TranscodingStream(codec::Codec, stream::IO; diff --git a/src/transcode.jl b/src/transcode.jl index 3a2ecb4d..2b8458ff 100644 --- a/src/transcode.jl +++ b/src/transcode.jl @@ -27,7 +27,6 @@ julia> decompressed = transcode(ZlibDecompressor, compressed); julia> String(decompressed) "abracadabra" - ``` """ function Base.transcode(::Type{C}, args...) where {C<:Codec} From 087bef3a1d22c6a467e010ac030166f681518280 Mon Sep 17 00:00:00 2001 From: Jakob Nybo Nissen Date: Fri, 13 Oct 2023 20:57:45 +0200 Subject: [PATCH 2/2] Remove MIToS downstream test This test uses `download`, which began to fail. --- .github/workflows/Downstream.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/Downstream.yml b/.github/workflows/Downstream.yml index 38fbf11a..d8da7c8a 100644 --- a/.github/workflows/Downstream.yml +++ b/.github/workflows/Downstream.yml @@ -26,7 +26,6 @@ jobs: - {user: JuliaIO, repo: CodecBzip2.jl, group: TranscodingStreams} - {user: BioJulia, repo: Automa.jl, group: TranscodingStreams} - {user: BioJulia, repo: FASTX.jl, group: TranscodingStreams} - - {user: diegozea, repo: MIToS.jl, group: TranscodingStreams} steps: - uses: actions/checkout@v2 - uses: julia-actions/setup-julia@v1