Types: Add jsdoc and fix notation format.#12
Open
Nielio wants to merge 1 commit intotmpvar:masterfrom
Open
Conversation
Fxlr8
suggested changes
Mar 31, 2020
Comment on lines
+5
to
+7
| export default class Vec2 { | ||
| public readonly x: number; | ||
| public readonly y: number; |
Contributor
There was a problem hiding this comment.
Maybe, remove the readonly from x and y? It produces lint errors when I just want to change a value fast without extra function call
Author
There was a problem hiding this comment.
I think it should stay readonly.
There are no setters implemented. The values are just simple attributes.
If you set the values directly, it would be like calling the set() function with notify = false.
From the docs:
none of the observers will be called.
Also, the internal clean() function would not be called. It validates the values.
This file contains hidden or 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
2 participants
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.
Changed the notation format from functions in attributes, to functinos.
Also corrected some return types.
The most important one: I applied the function documentation from the readme.