-
Notifications
You must be signed in to change notification settings - Fork 19
docs: add method documentation for Dictionaries, Distributions and Glossaries APIs #113
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
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #113 +/- ##
=======================================
Coverage 98.38% 98.38%
=======================================
Files 63 63
Lines 3130 3130
=======================================
Hits 3079 3079
Misses 51 51 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds YARD-style documentation comments to API resource methods across three files. The documentation includes parameter descriptions with types and links to both standard and Enterprise API documentation.
- Adds YARD documentation to all public methods in the Glossaries, Distributions, and Dictionaries modules
- Documents method parameters with their types and descriptions
- Includes reference links to Crowdin API documentation for each method
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| lib/crowdin-api/api_resources/glossaries.rb | Adds comprehensive documentation to 22 glossary-related API methods |
| lib/crowdin-api/api_resources/distributions.rb | Adds documentation to 8 distribution-related API methods |
| lib/crowdin-api/api_resources/dictionaries.rb | Adds documentation to 2 dictionary-related API methods |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
andrii-bodnar
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Besomhead thank you!
Partially covers #34.