clarify documentation around checkpoint vs output
Open
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 108
- Forks
- 37
- PR merge metrics
- No merged PRs in 30d
Description
nowhere in the documentation do we clarify the difference between what happens for SCR_FLAG_OUTPUT and SCR_FLAG_CHECKPOINT. To further confuse the issue, we have SCR_Start_output and SCR_Start_checkpoint. It is unclear that one is the superset of the other.
Thanks @white238
Contributor guide
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
Locate the documentation for SCR_FLAG_OUTPUT, SCR_FLAG_CHECKPOINT, SCR_Start_output, and SCR_Start_checkpoint. Read the surrounding descriptions and examples first, then clarify how the two flags and start functions differ, including which is the superset. Done means a newcomer can distinguish checkpoint behavior from output behavior without relying on source code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100