indygreg / indygreg/python-zstandard

Usage examples

Open
#123 5 comments 3 reactions 0 assignees View on GitHub
Dominant language
C
Stars
642
Forks
116
Avg merge
1d 14h
Merged PRs (30d)
5

Description

Hello there! It was awesome to find your library and I'd like to test it. I appreciate all the time and effort you put into it and writing the documentation. One thing that is missing (which I think is very important) is some usage examples for each case (one shot vs streaming) for both compression and decompression. I imagine this is much easier to do than all the other docs you already wrote but it will help newcomers tremendously, as they will have a place to start. I would put that right after "Installing", before the "Concepts" section. This would give a feel for how one should use the library.

This should also help with issue #18 (if I would have such examples I might take a stab at implementing the cmd line interface).

Thanks again!

Contributor guide

Open the contributing guide

Research direction

Locate the documentation section after "Installing" and before "Concepts", then review the surrounding documentation for its example style. Add usage examples covering one-shot and streaming compression and decompression, with enough context for newcomers to use the library; done means all four cases are represented clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.