-
Notifications
You must be signed in to change notification settings - Fork 4.7k
docgen: Omit unknown type tag from Markdown format output #19571
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
Merged
Conversation
This file contains hidden or 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
gziolo
approved these changes
Jan 13, 2020
Member
gziolo
left a comment
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.
It looks like a reasonable way to handle such cases for the time being 👍
oandregal
reviewed
Jan 13, 2020
75 tasks
Member
Author
|
I somehow missed that types are output for a number of tags, so I updated in e9da943 to output the "unknown type" more consistently (caught a few more cases in the subsequent 4e10bce). |
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.
Related: #18045
Unblocks: #19520
This pull request seeks to resolve an issue where, if
docgenencounters a type that it cannot parse, the Markdown formatter will output anullliteral value for the type. With these changes, it willsimply not output a type at alloutput text indicating that the type is unknown, in order to avoid misleading the reader into thinking the type isnullwhen it is not.This should be considered an interim solution to the larger problem of substituting Doctrine (#18045) in order to use more complex TypeScript types (#18838).
Testing Instructions:
Verify unit tests pass:
Verify there are no changed documentation after running: