This lacks any documentation....
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- c
- Domain
- documentation
Research direction
The report asks for documentation of return values, especially for the "extended" functions, and mentions a circular-buffer use case for MP3 data. Start by reading the public API and the extended-function declarations to see what each returns and whether bytes consumed are reported. "Done" means docs that let a user tell what each function returns and how much input it consumed; confirm with the maintainer which functions are in scope first, since the issue names no files or tests.
Written by the indexing model from the issue text.
Description
I don't even know what the functions are returning... Particularly extended functions. I want to implement circular buffer for mp3 data and It seems the functions don't return how many bytes they consumed...
- Dominant language
- C
- Stars
- 2k
- Forks
- 271
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from lieff/minimp3
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
[Bug]signed left-shift overflow in mp3dec_skip_id3v1 when parsing the APEv2 tag-size field (CWE-190)Possibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Integer overflow in Xing/Info VBR header parsing leads to ~10TB allocation (DoS)Possibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 Half a day Newbie friendliness 30/100
-
Difficulty 3/5 1-2 days Newbie friendliness 50/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 1 day
-
area:docs area:stdlib found-by:duet-audit kind:docs-drift
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
InauguralSystems/EigenScript#2251 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
flux-framework/flux-coral2#513 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
ly05010419/MacNativeGames#1420 ·
Maintainers usually reply within 1 day
-
Isaac workingOpen
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
seedds/nxnative#763 · 1 comment ·
Maintainers usually reply within 1 day