-
Notifications
You must be signed in to change notification settings - Fork 12.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Check overload tag against implementation #52474
Merged
sandersn
merged 10 commits into
microsoft:main
from
sandersn:check-overload-tag-against-implementation
Feb 16, 2023
Merged
Check overload tag against implementation #52474
sandersn
merged 10 commits into
microsoft:main
from
sandersn:check-overload-tag-against-implementation
Feb 16, 2023
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
Also, make @overload work like other jsdoc tags: only the last jsdoc tag before a declaration is used. That means all overload tags need to be in one tag: ```js /** * @overload * @return {number} * * @overload * @return {string} */ ``` function f() { return "1" } This no longer works: ```js /** * @overload * @return {number} */ /** * @overload * @return {string} */ function f() { return "2" } ``` Fixes microsoft#51234
Looks like you'll need to merge from |
DanielRosenwasser
approved these changes
Feb 14, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good - though the placement of the test is weird.
5 tasks
Main is failing after this has been merged; some conflict? |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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.
Edit: It turns out that the semantics below only work for overloads that specify a return type. Otherwise the parser doesn't know where the last
@overload
ends if it's missing@return
. WhilenoImplicitAny
prompts to add@return
, it's off in most JS scenarios.I'm still not happy that we're encouraging people to split their tags, but I don't see a good way around it.
Nope, Below Idea Doesn't Work
Also, make @overload work like other jsdoc tags: only the last jsdoc tag
before a declaration is used. That means all overload tags need to be in
one tag:
function f() { return "1" }
This no longer works:
@DanielRosenwasser this is a break from what is described in the beta blog post, but I really want
@overload
to work the same way as the rest of our jsdoc tags. At the time I changed the existing tag's behaviour, I found that almost nobody split their tags out this way, so I don't want to encourage people to start.Fixes #52367
Followup to #51234