Skip to content

docs: add yardoc for client resources and resource class methods - #63

Merged
tharropoulos merged 21 commits into
typesense:masterfrom
tharropoulos:yardoc
Nov 9, 2026
Merged

tharropoulos merged 21 commits into
typesense:masterfrom
tharropoulos:yardoc

Conversation

@tharropoulos

Copy link
Copy Markdown
Collaborator

Change Summary

  • annotate each public resource method with description, @example, and @see link sourced from the JS and PHP clients
  • split Client's grouped attr_reader into per-resource accessors with YARD blocks so each shows up under hover
  • adapt examples to ruby idioms — client.collections['products'] bracket access, string-key hashes, no trailing parens
  • keep /29.0/ versioned docs links on legacy AnalyticsV1 and collection-scoped Synonyms, /latest/ everywhere else
  • mark AnalyticsV1, Synonyms, and Synonym with @deprecated pointing to the v30 replacements

PR Checklist

@tharropoulos
tharropoulos merged commit 41cd83f into typesense:master Nov 9, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant