リンク切れになっていた参照の記法ミスとタイポを修正#3313
Open
Watson1978 wants to merge 1 commit into
Open
Conversation
静的 HTML を生成して href を検証したところ、参照先のページが存在しない リンクが多数あった。そのうち原因が記法ミスとタイポに限られるものを直した。 - メソッドを [c:] で参照していたもの (24箇所) 例: [c:OpenSSL::X509::Extension#oid] -> [m:OpenSSL::X509::Extension#oid] - 定数を [c:] で参照していたもの (6箇所) 例: [c:OpenSSL::PKCS7::TEXT] -> [m:OpenSSL::PKCS7::TEXT] - 末尾の ? の付け忘れ (1箇所) [m:String#valid_encoding] -> [m:String#valid_encoding?] - 定数名のタイポ (3箇所) [m:GetoptLong::REQUIRE_ARGUMENT] -> [m:GetoptLong::REQUIRED_ARGUMENT] [m:Socket::AI_CANONINAME] -> [m:Socket::AI_CANONNAME] どちらも実機で誤記側が存在せず、正しい綴りのみ存在することを確認した。 参照先が実在することは DB で確認済み。リンク切れは 266 種から 238 種に減った。 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Member
|
レビューありがとうございます。変更された 32 箇所すべてを、各エントリの定義( 特に 代表的な確認:
いずれも括弧内の記法・綴りの修正のみで、周囲の地の文や意味には手が入っていない点も確認しました。ありがとうございました。 |
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.
概要
リンク切れになっている参照のうち、原因が記法ミスとタイポに限られるものを直しました。
18 ファイル・32 箇所です。参照先が実在することは DB で確認しています。
見つけ方
rake statichtml:4.0で静的 HTML を生成し、出力されたhrefのうち生成物に対応するページが無いものを集めました。読者から見て 404 になるリンクです。
参照先が存在しなくても bitclust は compileerror にせず、存在しない URL への
リンクを黙って生成するため、lint も DB 生成も通ってしまいます。
内訳
メソッドを
[c:]で参照していたもの (24 箇所)[c:OpenSSL::X509::Extension#oid]のようにメソッドをクラス参照で書いており、[m:...]が正しい記法です。openssl / irb / psych / rexml / drb / csv /net-imap の各ライブラリと
doc/news/2_7_0.mdにありました。定数を
[c:]で参照していたもの (6 箇所)[c:OpenSSL::PKCS7::TEXT]など。同じく[m:...]が正しい記法です。末尾の
?の付け忘れ (1 箇所)[m:String#valid_encoding]→[m:String#valid_encoding?]定数名のタイポ (3 箇所)
どちらも実機で誤記側は存在せず、正しい綴りのみ存在することを確認しました。
文脈も
NO_ARGUMENT/OPTIONAL_ARGUMENTと並ぶ列挙、getaddrinfoのフラグ指定であり、意図は明らかです。
今回含めていないもの
同じ調査で他にもリンク切れが見つかっていますが、原因が異なり判断が要るため
分けています。
doc/news/2_4_0.mdのNet::HTTP.postは 2.4 で追加されたクラスメソッドの紹介で、収録されていないことが原因)
Fixnum/Bignum/Object#taintなど)module_functionかどうかの違い)api/_builtin/Thread.mdの 2 件は Thread: native_thread_id・thread_variables・each_caller_location を追加 #3308 と同じファイルのため、そちらに含めるか相談中です
検証
rake check_format/check_blank_lines/check_indent_in_samplecode/check_single_space_indent新たに壊れたリンクが増えていないことを確認しました
(リンク切れ 266 種 → 238 種)
🤖 Generated with Claude Code