memcpy and malloc_in_sandbox documentation
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 319
- Forks
- 24
- PR merge metrics
- No merged PRs in 30d
Description
It would be useful to document this a bit better.
For memcpy: the last parameter the number of elements, right? The type makes it seem like that is indeed the case; since this is different from POSIX memcpy which takes the number of bytes, we should be clear about this.
For malloc: it's again the length of elements not bytes, right? (no argument = 1?)
I can update docs on ACK.
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
Start by locating the existing documentation and declarations for memcpy and malloc_in_sandbox. Confirm whether their length arguments count elements or bytes, and whether malloc_in_sandbox has a default length. Done means the documentation clearly states these semantics, including the no-argument behavior if applicable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100