Inconsistent document descriptions in DynamicTexture class
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 40.3k
- Forks
- 7.2k
- PR merge metrics
- No merged PRs in 30d
Description
Version
- Phaser Version: 4.0.0
- Operating system:
- Browser:
Description
https://github.com/phaserjs/phaser/blob/master/src/textures/DynamicTexture.js#L761-L763
* You can pass in a string in which case it will look for a texture in the Texture
* Manager matching that string, and draw the base frame. If you need to specify
* exactly which frame to draw then use the method `drawFrame` instead.
But drawFrame method is not existed (removed already) in DynamicTexture class in phaser4.
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
Open src/textures/DynamicTexture.js around lines 761-763 and review the document comment describing the missing drawFrame method. Update the description to match the DynamicTexture API that exists in Phaser 4, then verify the obsolete method reference is no longer present.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 75/100