Repository navigation
docs: コードコメントを平易な技術英語に書き直す - #41
Merged
Merged
Conversation
既存のコメントは文法的には正しいが、関係節の入れ子や日常語への 言い換えが多く、一読で意味を取りにくい。全面的に書き直す前に、 書き直しの基準となるルールを定める。 Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
CLAUDE.md の Comments > Style に合わせて index パッケージのコメントを 書き直した。用語は key / entry / directory entry / unpin に統一。 コードとテストケース名は変更していない。 Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
CLAUDE.md の Comments > Style に合わせてコメントを書き直した。 コードとテストケース名は変更していない。 Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
CLAUDE.md の Comments > Style に合わせてコメントを書き直した。 コードとテストケース名は変更していない。 Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
CLAUDE.md の Comments > Style に合わせてコメントを書き直した。 コードとテストケース名は変更していない。 Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
CLAUDE.md の Comments > Style に合わせてコメントを書き直した。 コードとテストケース名は変更していない。 Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
CLAUDE.md の Comments > Style に合わせてコメントを書き直した。 コードとテストケース名は変更していない。 Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
CLAUDE.md の Comments > Style に合わせてコメントを書き直した。 コードとテストケース名は変更していない。 Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
CLAUDE.md の Comments > Style に合わせてコメントを書き直した。 コードとテストケース名は変更していない。 Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
CLAUDE.md の Comments > Style に合わせてコメントを書き直した。 コードとテストケース名は変更していない。 Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
CLAUDE.md の Comments > Style に合わせてコメントを書き直した。 コードとテストケース名は変更していない。 Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
CLAUDE.md の Comments > Style に合わせてコメントを書き直した。 コードとテストケース名は変更していない。 Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
CLAUDE.md の Comments > Style に合わせてコメントを書き直した。 コードとテストケース名は変更していない。 Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
CLAUDE.md の Comments > Style に合わせてコメントを書き直した。 コードとテストケース名は変更していない。 Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
CLAUDE.md の Comments > Style に合わせてコメントを書き直した。 コードとテストケース名は変更していない。 Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
CLAUDE.md の Comments > Style に合わせてコメントを書き直した。 コードとテストケース名は変更していない。 Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
CLAUDE.md の Comments > Style に合わせてコメントを書き直した。 コードとテストケース名は変更していない。 Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Comments > Style のルールを CLAUDE.md 自身の説明文にも適用した。 テストケース名の例は実際のテスト名と対応しているため変更していない。 Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
概要
コードコメントの英文を、一読で意味が取れる文体に書き直した。コードとテストケース名は変更していない。
これまでのコメントは文法的には正しいが、次の理由で読みにくかった。
filed under、gives back、goes downなど)What was opened before a failure is closed again)変更は次の 3 つ。
CLAUDE.mdのCommentsにStyleを追加し、書き方のルールを 5 つ定めたCLAUDE.md自身の説明文も同じルールで書き直したレビューの進め方
差分は 181 ファイル、約 5,000 行と大きいが、コミットはパッケージごとに分けてある。
.goファイルについて、コメント行を除いたmainとの差分が空であることを機械的に確認した。コードの変更を探す必要はない。metadata_manager/indexinfo.goのIndexInfo(トランザクションを保持する理由)query/constant.goのConstant(型を保持する理由と==の説明)plan/tableplanner.goのmakeProductPlan(SimpleDB との違い)設計上の判断
key、リーフのレコードはentry、ディレクトリのレコードはdirectory entryとした。ほかにgives backはunpins/returns、is refusedはis rejected、the scan underneathはthe underlying scan、a guess atはan estimate ofに揃えた。recovery_managerや短いアクセサの説明などが該当する。.golangci.ymlとci.ymlのコメントも同じ理由で変更していない。CLAUDE.md内のテストケース名の例は変更していない。 実際のテスト名と対応しているため。既知の制限
filed underが 3 か所残っている(index/btreeleaf.go、index/btreepage.go、index/hashindex.go)。コメントではなくコードなので、この PR では変更していない。go test ./...、gofmt、go vetは手元で通っている。golangci-lintは手元に入っていないため実行していない。-raceと-shuffle=on付きのテストも手元では実行していない。🤖 Generated with Claude Code