Skip to content

chore: translate Japanese comments and docs to English - #102

Merged
valbeat merged 1 commit into
mainfrom
chore/translate-comments-to-english
Jul 9, 2026
Merged

chore: translate Japanese comments and docs to English#102
valbeat merged 1 commit into
mainfrom
chore/translate-comments-to-english

Conversation

@valbeat

@valbeat valbeat commented Jul 9, 2026

Copy link
Copy Markdown
Owner

Summary

日本語のコメント・docblock・設定を英語化しました。

  • src/Result インターフェースの全 docblock、Ok / Err / Results / UnwrapException のクラス・メソッド説明・インラインコメント
  • tests/Types/result.php の全テスト docblock とインラインコメント、ErrTest / OkTest / ResultsTest のヘルパー・フィクスチャ説明
  • .coderabbit.yamltone_instructions と全 path_instructions を英語化、language: jalanguage: en-US

Kept as-is

tests/ErrTest.phpstr_repeat('あ', 200) は UTF-8 切り詰め境界を検証するマルチバイトテストデータ(文字列リテラル)のため維持。.idea/ 配下は IDE 設定のため対象外。

Verification

  • phpunit: 78 tests, 124 assertions — OK
  • phpstan analyse: No errors

コメント・ドキュメントのみの変更で、実行時の挙動は変わりません。

https://claude.ai/code/session_014UL25HVV4YV6N7uZc9bZA1

Translate all Japanese docblocks, inline comments, and CodeRabbit
review instructions to English across src/, tests/, and .coderabbit.yaml.
Also switch CodeRabbit review language from ja to en-US.

The multibyte test fixture (str_repeat('あ', 200)) is kept as-is since
it verifies UTF-8 truncation behavior.

Claude-Session: https://claude.ai/code/session_014UL25HVV4YV6N7uZc9bZA1
@valbeat valbeat self-assigned this Jul 9, 2026
@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@valbeat, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 26 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 5d20126c-f2ef-427c-a082-58c53479c9b1

📥 Commits

Reviewing files that changed from the base of the PR and between 41da4e7 and e3c9d61.

📒 Files selected for processing (10)
  • .coderabbit.yaml
  • src/Err.php
  • src/Ok.php
  • src/Result.php
  • src/Results.php
  • src/UnwrapException.php
  • tests/ErrTest.php
  • tests/OkTest.php
  • tests/ResultsTest.php
  • tests/Types/result.php
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/translate-comments-to-english

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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

Copy link
Copy Markdown

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 translates configuration instructions, docblocks, inline comments, and test descriptions from Japanese to English across the entire codebase, including the .coderabbit.yaml configuration, core source files, and test suites. I have no feedback to provide.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

@codecov

codecov Bot commented Jul 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (41da4e7) to head (e3c9d61).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@             Coverage Diff             @@
##                main      #102   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
  Complexity        65        65           
===========================================
  Files              4         4           
  Lines            130       130           
===========================================
  Hits             130       130           
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

@valbeat
valbeat marked this pull request as ready for review July 9, 2026 09:22
Copilot AI review requested due to automatic review settings July 9, 2026 09:22
@valbeat
valbeat merged commit 6a8352b into main Jul 9, 2026
12 checks passed
@valbeat
valbeat deleted the chore/translate-comments-to-english branch July 9, 2026 09:22

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 translates Japanese comments, PHPDoc/docblocks, and review configuration guidance into English across the Result library and its test suite, keeping runtime behavior unchanged.

Changes:

  • Translated PHPDoc/docblocks and inline comments in src/ (Result API docs, helpers, and exception docs) to English.
  • Translated test docblocks and inline comments in tests/, including PHPStan type-assertion fixture explanations.
  • Updated .coderabbit.yaml review instructions and language setting to English (en-US).

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
tests/Types/result.php Translates PHPStan-focused docblocks and inline comments describing narrowing/inference behavior.
tests/ResultsTest.php Translates a helper docblock clarifying literal-type widening in tests.
tests/OkTest.php Translates a helper docblock about widening literal types for covariance behavior.
tests/ErrTest.php Translates inline/test fixture comments; keeps multibyte test data unchanged.
src/UnwrapException.php Translates class/method docs explaining unwrap/expect exception behavior and truncation strategy.
src/Results.php Translates docs for static helper methods (try, combine, flatten).
src/Result.php Translates the public interface docblocks for the Result API.
src/Ok.php Translates the Ok class doc summary.
src/Err.php Translates the Err class doc summary.
.coderabbit.yaml Translates review instructions and sets the review language to English.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/Result.php

/**
* 成功の場合はokを、失敗の場合はerrを適用します.
* Applies ok on success, or err on failure.
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.

2 participants