Improve documentation for Tagged #943
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 JSDoc deprecation tags at the bottom are easy to miss when you read the source.
I considered leaving the deprecated Opaque types in opaque.d.ts, but that would require that we export the shared `Tag` type, and I'm not sure if that would cause it to be suggested by IDEs.
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.
Since the source code acts as documentation, this PR tries to make it clearer by moving the old
Opaquetype out of the way as much as possible. It's a series of 4 commits -- please feel free to cherry pick up to whichever commit you feel is good.