Skip to content

Commit 98ca527

Browse files
committed
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`
1 parent c8b8369 commit 98ca527

File tree

6 files changed

+8
-13
lines changed

6 files changed

+8
-13
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@
33
*.jl.mem
44
/Manifest.toml
55
/docs/build/
6+
/docs/Manifest.toml

docs/Project.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
[deps]
2-
CodecZlib = "944b1d66-785c-5afd-91f1-9de20f533193"
32
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
43
TranscodingStreams = "3bb67fe8-82b1-5028-8e26-92a6c54297fa"
54

65
[compat]
7-
Documenter = "~0.27"
6+
Documenter = "1"

docs/make.jl

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
using Documenter
22
using TranscodingStreams
3-
using CodecZlib
43

54
makedocs(
65
sitename="TranscodingStreams.jl",

docs/src/reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ TranscodingStream
1010

1111
```@docs
1212
TranscodingStream(codec::Codec, stream::IO)
13-
transcode(::Type{C}, args...) where {C<:Codec}
14-
transcode(::Codec, ::Buffer, ::Union{Buffer,Nothing})
13+
transcode
14+
TranscodingStreams.unsafe_transcode!
1515
1616
TranscodingStreams.transcode!
1717
TranscodingStreams.TOKEN_END

src/stream.jl

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -97,17 +97,14 @@ Examples
9797
```jldoctest
9898
julia> using TranscodingStreams
9999
100-
julia> using CodecZlib
100+
julia> file = open(joinpath(dirname(dirname(pathof(TranscodingStreams))), "README.md"));
101101
102-
julia> file = open(joinpath(dirname(pathof(CodecZlib)), "..", "test", "abra.gz"));
102+
julia> stream = NoopStream(file);
103103
104-
julia> stream = TranscodingStream(GzipDecompressor(), file);
105-
106-
julia> String(read(stream))
107-
"abracadabra"
104+
julia> readline(file)
105+
"TranscodingStreams.jl"
108106
109107
julia> close(stream)
110-
111108
```
112109
"""
113110
function TranscodingStream(codec::Codec, stream::IO;

src/transcode.jl

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ julia> decompressed = transcode(ZlibDecompressor, compressed);
2727
2828
julia> String(decompressed)
2929
"abracadabra"
30-
3130
```
3231
"""
3332
function Base.transcode(::Type{C}, args...) where {C<:Codec}

0 commit comments

Comments
 (0)