chore: generate docs for the protocol #6213
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
mathiasbynens
approved these changes
Jul 13, 2020
jackfranklin
force-pushed
the
generate-docs-for-devtools-protocol
branch
from
2fb3389
to
e078bb7
Compare
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 motivation here is that in our code we often say a function takes an argument that is of type
Protocol.X.We then have some options for how we document this well:
None of these are great options, so instead what we can do is tell API Extractor to generate API docs for the
devtools-protocolpackage. This means if we havefunction x(someArg: Protocol.Y)the docs will generate a link onProtocol.Xthat the user can click to be taken to documentation for that part of the protocol.We can improve the situation further with some small tweaks to the devtools protocol generator to make the outputted comments TSDoc compliant (I will be doing that today) but this PR just dumps in the generated documentation (there's quite a lot!.