JuliaIO / JuliaIO/TranscodingStreams.jl
Documenting its behaviour better
Open
@mkitti is already working on this.
Since Aug 5, 2022.
- Dominant language
- Julia
- Stars
- 90
- Forks
- 25
- PR merge metrics
- No merged PRs in 30d
Description
A good start is documenting its behaviour better - what is the buffer growth behaviour? How does one stop a transcoding? What is the "mark" in the buffer and how does one set and clear it?
I think documenting all supported behaviours is a good starting point for thinking about the API. For example, the way to stop a transcoding is to write a TOKEN_END to a stream. The obscurity of that suggests perhaps that should be a method instead
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.
Assessment
This issue has not been assessed yet.