openframeworks / openframeworks/openFrameworks
Group: Needs Comments
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 10.4k
- Forks
- 2.6k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 9
Description
Some chunks of openFrameworks need comments to describe their input/output range or the units of their output. This should generally be covered by the documentation, but if a function/method is especially ambiguous then it should have a single line of documentation. If a section has been commented out, it should also be explained why.
This is a group of issues identified during Code Review 2012. Add any relevant issues to this group, and when they are all closed we will close this issue. If an issue fits this pattern, but is more significant or not a simple fix, please add it as a separate issue.
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
Start by reviewing the grouped issues identified during Code Review 2012 and identify one still-open comment task that fits the stated pattern. Check the relevant function or section for missing input/output ranges, units, ambiguous behavior, or an unexplained commented-out section. Done means the applicable documentation is added and the related grouped issue is closed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100