tsdoc comments and readme for @polywrap/client-js #1333
Merged
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.
This PR adds comments in the TSDoc format to public methods of the JS PolywrapClient, and adds a readme with full reference documentation based on the comments.
The benefits of this approach:
.d.ts
file, which contains the comments. Although I did this part manually, it could be automated with a script.This makes it easy for us to keep reference documentation up to date.
Related:
Documentation Roadmap (hackmd)
Summary of Documentation Roadmap (discord)
Closes polywrap/documentation#206