HaxeFlixel / HaxeFlixel/flixel-ui
Missing documentation on FlxUICheckBox's and FlxUITabMenu's "new" functions.
Nobody has claimed this yet.
- Dominant language
- Haxe
- Stars
- 201
- Forks
- 75
- PR merge metrics
- No merged PRs in 30d
Description
I was having trouble finding out how some of it parameters work because there isn't documentation and the variable names aren't much intuitive. Also, I can't do the comments myself.
FlxUICheckBox
FlxUITabMenu
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 with flixel/addons/ui/FlxUICheckBox.hx at line 71 and flixel/addons/ui/FlxUITabMenu.hx at line 142, focusing on each class's new function. Read the existing declarations and surrounding code to determine what the parameters mean, then document the parameters and their purpose. Done means both functions have clear comments explaining their arguments.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100