Fix missing parameter descriptions in docs #212
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
The parameter descriptions were missing for any destructured parameters. Apparently TypeDoc doesn't support showing descriptions for destructured parameters (see here for more details: [1]). I have forked TypeDoc to fix this problem, and published this fork as `@gudahtt/typedoc@0.23.0`. We can use this fork until this has been resolved upstream. [1]: TypeStrong/typedoc#1703
ryanml
approved these changes
Sep 20, 2021
|
I could! I was hoping this would be a short-term thing. I can migrate it to the MetaMask org if I have trouble landing this upstream. |
|
sounds good! lgtm |
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.
The parameter descriptions were missing for any destructured parameters. Apparently TypeDoc doesn't support showing descriptions for destructured parameters (see here for more details).
I have forked TypeDoc to fix this problem, and published this fork as
@gudahtt/typedoc@0.23.0. We can use this fork until this has been resolved upstream.