docs: add jsdocs to public api classes and methods#351
Open
tharropoulos wants to merge 24 commits into
Open
Conversation
docs(analytics-v1): pin doc links to v29 for deprecated v1 api
…ride and synonym methods
This file contains hidden or 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
1 participant
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.
Change Summary
Adds JSDoc with one-line summaries, @example call chains, and @see docs links to every resource class in src/Typesense/, sourced from the OpenAPI spec. Hovering on client.keys, client.collections("products").documents().import(...), etc. surfaces the right description, a runnable example, and a link to the relevant docs section.
PR Checklist