Fix documentation issues #187

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.

Sign up for GitHub

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

Jump to bottom

Merged

oschwald merged 14 commits into main from wstorey/tweaks

Jan 15, 2026

Contributor

horgh commented Jan 15, 2026

No description provided.

horgh and others added 14 commits

January 15, 2026 14:10


          Fix README documentation issues

476cefa

* Fixed code fence with extra backtick
* Corrected response class name to Minfraud::HTTPService::Response
* Added missing InvalidInputError to exceptions list
* Updated copyright year to 2026

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>


          Fix CreditCard component documentation

a2bb3b4

* Added guidance to send last four digits for last_digits field
* Fixed YARD link syntax for instance attribute references
* Fixed SafeKey capitalization

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>


          Fix Email component documentation URL

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>


          Fix component documentation

46f9235

* Fixed event time constraint from 10 years to 1 year
* Fixed max value from 1e14 to 1e13 for order amount and cart item price
* Fixed shopping cart documentation URLs

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>


          Fix order amount max value in documentation

04564af

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>


          Fix ShoppingCartItem documentation

34158a7

* Fixed documentation URLs
* Fixed price max value from 1e14 to 1e13

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>


          Fix Response documentation

b9750ba

* Changed Fixnum to Integer (Fixnum deprecated in Ruby 2.4+)
* Added Minfraud::Model::Error to body return types

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>


          Document earliest date for email first_seen field

2fd0344

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>


          Document earliest date for email domain first_seen field

6e0b845

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>


          Improve EmailDomainVisit documentation

f68f691

* Clarified has_redirect description
* Updated status value descriptions for accuracy

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>


          Fix YARD link syntax in Factors model

f60ec70

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>


          Fix ShippingAddress documentation

476a4f0

* Fixed grammar in distance_to_billing_address description
* Added missing @return tag for is_high_risk

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>


          Add missing warning codes to Warning documentation

3c61b8d

Added: BILLING_REGION_NOT_FOUND, EMAIL_ADDRESS_UNUSABLE,
IP_ADDRESS_INVALID, IP_ADDRESS_RESERVED, SHIPPING_REGION_NOT_FOUND

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>


          Update copyright year to 2026

f4e8a8c

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

gemini-code-assist bot commented Jan 15, 2026

Summary of Changes

Hello @horgh, I'm Gemini Code Assist¹! 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 primarily focuses on a comprehensive review and enhancement of the project's documentation. The changes aim to improve the accuracy, clarity, and completeness of inline comments, README content, and license information. By correcting outdated details, refining descriptions, and adding missing information, this PR ensures that developers have access to precise and up-to-date guidance when working with the codebase.

Highlights

Documentation Clarity and Accuracy: Numerous documentation comments have been updated across various files to improve clarity, correct inaccuracies, and provide more precise descriptions for fields, return types, and error conditions. This includes clarifications for last_digits in CreditCard, valid time windows for Event timestamps, and value ranges for Order amounts.
Copyright Year Updates: The copyright year for MaxMind, Inc. has been updated from 2025 to 2026 in both LICENSE.txt and README.md.
Exception and Warning Information: The README.md now includes InvalidInputError in its list of exception types. Additionally, the Warning model has been significantly expanded with new warning codes and their detailed descriptions, such as BILLING_REGION_NOT_FOUND, EMAIL_ADDRESS_UNUSABLE, IP_ADDRESS_INVALID, IP_ADDRESS_RESERVED, and SHIPPING_REGION_NOT_FOUND.
Code Reference and Type Corrections: Several YARD references (e.g., {::issuer_id_number} to {#issuer_id_number}) have been corrected in CreditCard and Factors models. The HTTPService::Response now correctly documents the status attribute as Integer instead of Fixnum and includes Minfraud::Model::Error as a possible return type for the body attribute.
Markdown and Typo Fixes: A Markdown code block syntax error in README.md was corrected, and a typo from 'Safekey' to 'SafeKey' was fixed in the CreditCard 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.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

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. ↩

gemini-code-assist bot reviewed

View reviewed changes

gemini-code-assist bot left a comment

Code Review

This pull request focuses on improving the documentation across the project. The changes include updating copyright years, fixing typos and formatting in README.md and code comments, correcting and clarifying documentation for various components and models to match the API behavior and constraints, adding missing YARD documentation tags, and expanding the list of documented warning codes. All the changes are appropriate and improve the quality and accuracy of the documentation. I have no further suggestions.

oschwald approved these changes

View reviewed changes

oschwald merged commit 3862c57 into main

30 checks passed

oschwald deleted the wstorey/tweaks branch

January 15, 2026 22:51

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet