Skip to content

Fully qualify exception class names in YARD @raise tags#161

Merged
horgh merged 1 commit intomainfrom
wstorey/docs
Mar 25, 2026
Merged

Fully qualify exception class names in YARD @raise tags#161
horgh merged 1 commit intomainfrom
wstorey/docs

Conversation

@horgh
Copy link
Contributor

@horgh horgh commented Mar 25, 2026

YARD could not resolve unqualified class names like AddressNotFoundError, rendering them without type information in generated documentation.

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>
@gemini-code-assist
Copy link

Summary of Changes

Hello, 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 @raise tags, the documentation tool can now properly link these exceptions, providing clearer and more useful type information for developers consuming the library.

Highlights

  • YARD Documentation: Exception class names in @raise tags have been fully qualified with their module paths (e.g., MaxMind::GeoIP2::HTTPError) to ensure YARD correctly resolves them and generates complete type information in the documentation.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link

@mm-jpoole mm-jpoole left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🥳

@horgh horgh merged commit 92e81fd into main Mar 25, 2026
36 checks passed
@horgh horgh deleted the wstorey/docs branch March 25, 2026 20:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants