Annotate code base with JSDoc comments #2944
Unanswered
danielrearden
asked this question in
Ideas
Replies: 1 comment
-
Totally in favor myself :) time is an issue :( |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
The majority of the code base needs to be annotated with JSDoc comments to facilitate the generation of API documentation. This issue is intended to track the progress around this.
I'm omitting any packages that are internal dependencies that are unlikely to be directly imported by anyone consuming
graphql-tools
, but if you think any of the omitted packages should also be documented, let me know and I can amend the list. Additional tasks relating to this process:@deprecated
tag where appropriate (for example anything relating to the legacy directive implementations)@internal
to any functions or types unlikely to be consumed directly to reduce the noise in the generated docs as much as possibleBeta Was this translation helpful? Give feedback.
All reactions