Fully qualify exception class names in YARD @raise tags#161
Conversation
YARD could not resolve unqualified class names like AddressNotFoundError, rendering them without type information in generated documentation. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request improves the accuracy and completeness of the generated YARD documentation. By explicitly specifying the full namespace for custom exception classes within Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request updates the @raise documentation tags in lib/maxmind/geoip2/client.rb and lib/maxmind/geoip2/reader.rb to use fully qualified exception names. The reviewer suggests refactoring the repeated @raise documentation blocks into YARD macros to improve maintainability and reduce duplication across methods in both files.
YARD could not resolve unqualified class names like AddressNotFoundError, rendering them without type information in generated documentation.