GroupCreateConfig.frame description: yes
Open
Nobody has claimed this yet.
📖 Docs
- Dominant language
- JavaScript
- Stars
- 40.3k
- Forks
- 7.2k
- PR merge metrics
- No merged PRs in 30d
Description
It's cool to have a description, it is better to be able to read it!
Produces a badly formatted ouput: https://docs.phaser.io/api-documentation/typedef/types-gameobjects-group#groupcreateconfig
It could be an issue with JSDoc.
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 at src/gameobjects/group/typedefs/GroupCreateConfig.js line 15 and compare its description with the rendered GroupCreateConfig documentation at the linked API page. Investigate whether the JSDoc formatting causes the output problem. Done means the description renders in a readable format on the API documentation page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100