-
-
Notifications
You must be signed in to change notification settings - Fork 457
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
docs(core): Add TSDocs annotations to @urql/core exported APIs #2962
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
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.
Summary
This adds TSDoc annotations to all exported APIs.
Generally, the style guide followed is:
@param
and@returns
tags are generally added and contain links@param
or@returns
tagsHint:
@see
links are added to refer to important, otherwise not linked, parts of the TSDocs or web links@throws
is added if it's not obvious that an API can explicitly throw an errorThis is the first PR that makes use of the build changes from #2956, which bundles all
d.ts
typings files, which gives a better TSDocs experience.Since we weren't sure whether slowly adding TSDocs to all our packages is worthwhile (it’s extremely time intensive) we ran polls to validate it:
At the time of creation of this PR,
Set of changes
@urql/core
exportsfallbackExchangeIO
export (not considered breaking/minor since it's unlikely to be used and was never meant to be exposed)