JuliaIO / JuliaIO/TranscodingStreams.jl
transcode for ByteData instead of only Vector{UInt8}
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 90
- Forks
- 25
- PR merge metrics
- No merged PRs in 30d
Description
I noticed that the documentation says, that the signature of transcode is
transcode(codec::Codec, data::Vector{UInt8})::Vector{UInt8}
but then for the code we have the signature
transcode(codec::Codec, data::ByteData)
Should maybe maybe the documentation be adjusted?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the documentation for the transcode signature shown for Vector{UInt8}, then compare it with the code signature accepting ByteData. Update the documentation so it reflects the implementation, and verify that the documented signature matches the current code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100