Fix jsdoc in setWordWrapWidth from Text and TextStyle #6813
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR
Describe the changes below:
I was using typescript phaser version when I found an issue with
Phaser.GameObjects.Text.setWordWrapWidth, the method description says: params width - The maximum width of a line in pixels. Set to null to remove wrapping.So I tried to set it to null.
But the following typescript error appeared. That's because the method jsdoc don't allow passing null, just undefined.
Reading the source code, I found that null is the correct value to pass here.
This PR changes the jsdoc to allow passing null to the method without errors.
I didn't generate the
.d.tsdefinitions withnpm run tsgen, which is something I think should be done by the maintainers of the project when new releases of the project are generated. Please do it after these changes.I hope it helps, have a nice day!