Tighten Closure type annotations. #4997
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
dfreedm
requested changes
Dec 15, 2017
lib/elements/array-selector.html
Outdated
| @@ -211,7 +211,7 @@ | |||
|
|
|||
| /** | |||
| * Clears the selection state. | |||
| * | |||
| * @returns {void} | |||
lib/elements/dom-bind.html
Outdated
| @@ -61,16 +61,19 @@ | |||
| this.__children = null; | |||
| } | |||
|
|
|||
| // assumes only one observed attribute | |||
| /** @returns {void} */ | |||
lib/elements/dom-bind.html
Outdated
| this.mutableData = true; | ||
| } | ||
|
|
||
| /** @returns {void} */ |
There was a problem hiding this comment.
@return is only necessary if the function takes arguments
There was a problem hiding this comment.
See below. Think we should keep these.
lib/elements/dom-bind.html
Outdated
| connectedCallback() { | ||
| this.style.display = 'none'; | ||
| this.render(); | ||
| } | ||
|
|
||
| /** @returns {void} */ |
There was a problem hiding this comment.
@return is only necessary if the function takes arguments
There was a problem hiding this comment.
I added it because otherwise in TypeScript we have to output returns any in this case, because we have no idea what the return type is.
lib/elements/dom-module.html
Outdated
| @@ -74,6 +74,10 @@ | |||
| return null; | |||
| } | |||
|
|
|||
| /** | |||
| * @param {string} name | |||
| * @returns {void} | |||
lib/elements/dom-module.html
Outdated
| @@ -74,6 +74,10 @@ | |||
| return null; | |||
| } | |||
|
|
|||
| /** | |||
| * @param {string} name | |||
There was a problem hiding this comment.
Add
@param {?string} old
@param {?string} value
There was a problem hiding this comment.
Done. Also had to add descriptions according to linter.
lib/legacy/legacy-element-mixin.html
Outdated
| @@ -134,6 +134,7 @@ | |||
| * @param {string} name Name of attribute. | |||
| * @param {?string} old Old value of attribute. | |||
| * @param {?string} value Current value of attribute. | |||
| * @returns {void} | |||
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.
I pulled these changes out of #4928. These are various changes to the Polymer core JSDoc annotations that improve the generated TypeScript declarations.
!non-nullable operators. In Closure, all non-primitive types are non-nullable (we should try to use non-nullable types by default going forward if possible).@privatethat are not part of our public API.@return {void}to some functions that don't return anything.gulp closureproduces no warnings