Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Bump Documenter to 1.0 #155

Merged
merged 2 commits into from
Oct 13, 2023
Merged

Bump Documenter to 1.0 #155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9836eab
Bump Documenter to 1.0
jakobnissen Oct 13, 2023
087bef3
Remove MIToS downstream test
jakobnissen Oct 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/Downstream.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
*.jl.mem
/Manifest.toml
/docs/build/
/docs/Manifest.toml
3 changes: 1 addition & 2 deletions docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
1 change: 0 additions & 1 deletion docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
using Documenter
using TranscodingStreams
using CodecZlib

makedocs(
sitename="TranscodingStreams.jl",
Expand Down
4 changes: 2 additions & 2 deletions docs/src/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 4 additions & 7 deletions src/stream.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
1 change: 0 additions & 1 deletion src/transcode.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ julia> decompressed = transcode(ZlibDecompressor, compressed);

julia> String(decompressed)
"abracadabra"

```
"""
function Base.transcode(::Type{C}, args...) where {C<:Codec}
Expand Down
Loading