Don't inherit jsdoc tags from overloaded signatures #43165
Conversation
Previously, when getting jsdoc for signatures, the services layer would get the jsdoc tags for the base symbol of a signature if it was present. This is fine except when the base was overloaded. In that case, the multiple signatures of the overload would all contribute jsdoc, which is not correct. A more correct fix would be to resolve overloads to the base, but the compiler doesn't have this capability and adding it or jury-rigging it seems like it would be complex, inappropriate for a fix to ship in a patch version. Co-authored-by: Orta Therox <git@orta.io>
typescript-bot
added
the
For Milestone Bug
| "kind": "punctuation" | ||
| } | ||
| ], | ||
| "documentation": [] |
There was a problem hiding this comment.
this line is the assertion we're interested in
| tags = [...inheritedTags, ...tags]; | ||
| } | ||
| }); | ||
| function getJsDocTagsOfSignature(declaration: Declaration, checker: TypeChecker): JSDocTagInfo[] { |
There was a problem hiding this comment.
This function is only called here, and is short, so I wanted to inline it, but it was non-trivial so I skipped it to keep the diff smaller. I couldn't help myself simplifying out the unused declarations: Declaration[] to declaration: Declaration, though.
|
Review reads better with whitespace ignored |
|
@a-tarasyuk you might be interested in this. I'm curious whether you have any clever ideas for resolving a call to its base interface. |
|
Is there a plan to release a version of 4.2 with this fix in it? Or just role this into 4.3? Right now I'm attempting to upgrade our repo to webpack 5 -> which means I need ts 4.2 (for the lib changes) and that is causing the |
|
Because the TC39 meetings are currently happening it's a little chaotic for another day or two on our side, but I'd say this is very likely heading towards a 4.2 patch. |
Previously, when getting jsdoc for signatures, the services layer would get the jsdoc tags for the base symbol of a signature if it was present. This is fine except when the base was overloaded. In that case, the multiple signatures of the overload would all contribute jsdoc, which is not correct. A more correct fix would be to resolve overloads to the base, but the compiler doesn't have this capability and adding it or jury-rigging it seems like it would be complex, inappropriate for a fix to ship in a patch version. Co-authored-by: Orta Therox <git@orta.io> Co-authored-by: Orta Therox <git@orta.io>
* Don't inherit jsdoc tags from overloaded signatures (#43165) Previously, when getting jsdoc for signatures, the services layer would get the jsdoc tags for the base symbol of a signature if it was present. This is fine except when the base was overloaded. In that case, the multiple signatures of the overload would all contribute jsdoc, which is not correct. A more correct fix would be to resolve overloads to the base, but the compiler doesn't have this capability and adding it or jury-rigging it seems like it would be complex, inappropriate for a fix to ship in a patch version. Co-authored-by: Orta Therox <git@orta.io> Co-authored-by: Orta Therox <git@orta.io> * Update baseline Co-authored-by: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com>
Previously, when getting jsdoc for signatures, the services layer would get the jsdoc tags for the base symbol of a signature if it was
present. This is fine except when the base was overloaded. In that case, the multiple signatures of the overload would all contribute jsdoc, which is not correct.
A more correct fix would be to resolve overloads to the base, but the compiler doesn't have this capability and adding it or jury-rigging it seems like it would be complex, inappropriate for a fix to ship in a patch version.
Co-authored-by: Orta Therox git@orta.io
Fixes #43053