docgen: fix qualified types with type parameters #61097
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
jsnajdr
added
[Type] Bug
jsnajdr
requested review from
nerrad,
ajitbohra,
ryanwelcher,
juanmaguitar,
fabiankaegy and
ndiego
as code owners
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
ellatrix
approved these changes
Apr 25, 2024
|
Size Change: 0 B Total Size: 1.75 MB ℹ️ View Unchanged
|
tyxla
approved these changes
Apr 25, 2024
| @@ -150,7 +150,7 @@ _Parameters_ | |||
|
|
|||
| _Returns_ | |||
|
|
|||
| - `undefined< 'edit' >`: Current user object. | |||
| - `ET.User< 'edit' >`: Current user object. | |||
There was a problem hiding this comment.
Nit: Maybe as a follow-up, we could add a clarification of what ET is. It's nowhere to be found in the doc file.
There was a problem hiding this comment.
Yes, the types are currently just names without meaning or explanation. Solving it is a multi-step task. First we need to generate docs also for the @template type arguments, docs for types, somehow cross-reference them etc.
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.
Fixed a docgen bug that I noticed when reviewing #60988 (comment). If a parameter has "qualified type name" and type parameters, i.e.
X.Y<Z>, the docgen tool failed to format that type to a string and producedundefined<Z>.It was a simple omission in the
getTypeReferenceTypeAnnotationthat correctly formattedX.Ywithout type parameters but forgot to check for the specialX.Ysyntax when there are type parameters.How to test:
getTypeAnnotationthat checks this case and would fail without the fix.core-datapackage -- note how nicely fixed they are now!