Documentation Update: ObservablePoint.ts #7415
Merged
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
|
Should be good to go. Please let me know if there are any issues.
|
|
Thanks for this @jrod-disco @SukantPal would be really nice to have a look at these inference issues with webdoc. |
bigtimebuddy
approved these changes
Apr 16, 2021
jrod-disco
commented
Apr 17, 2021
| * Creates a new `ObservablePoint` | ||
| * | ||
| * @param cb - callback function triggered when `x` and/or `y` are changed | ||
| * @param scope - owner of callback | ||
| * @param {number} [x=0] - position of the point on the x axis |
There was a problem hiding this comment.
Explicit type / default was needed here. Not sure if there's a better way around this.
jrod-disco
commented
Apr 17, 2021
| * | ||
| * @member {number} | ||
| /** Position of the observable point on the x axis | ||
| * @type {number} |
There was a problem hiding this comment.
Again, needed to explicitly set the type of this member. It wasn't inferring on either getter or setter.
ShukantPal
approved these changes
Apr 17, 2021
bigtimebuddy
added
the
✅ Ready To Merge
|
Thank you @jrod-disco 🎉 |
bigtimebuddy
pushed a commit
that referenced
this pull request
Apr 27, 2021
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.
Description of change
Update docs for
ObservablePoint.tsfix- update documentation according to: Help Wanted: Reformatting Documentation #7159I made the assumption that we're attempting to document the surface API and there was no need to expose
_xand_yinternals. Please correct me if I'm wrong in this assumption.Note: That there seems to be an issue with webdoc not properly inferring types from documentation on getters (and likely setters). Followed workaround provided by @bigtimebuddy here: webdoc-labs/webdoc#100
Pre-Merge Checklist
npm run lint)npm run test)