今日は主にドキュメントの追加/修正がありました。
[aab74eafde] Nobuyoshi Nakada 2023-12-17 12:17:48 UTC
Travis-CI の設定でコミットログに [DOC] が含まれていた時に実行しないようにしています。
[7bfa1c3dc9] Nobuyoshi Nakada 2023-12-17 13:37:15 UTC
昨日の ext/socket/mkconstants.rb の cbda94edd80b0f664eda927f9ce9405b2074633a でのコメントがない時のデフォルトを ":nodoc:" にする変更を revert しています。 rb_define_const() の前のコメントでは :nodoc: タグが思ったように効いてなかったみたいです。
[e316128e3d] Nobuyoshi Nakada 2023-12-17 23:38:59 UTC
ext/socket/mkconstants.rb で拡張ライブラリ socket の定数のための C コード生成する時に rdoc 用コメント内のクラス名と同じ文字列のクロスリファレンス生成を抑制するためのエスケープを追加するための置換。
[71c4a9c38f] Nobuyoshi Nakada 2023-12-17 23:47:59 UTC
拡張ライブラリ socket の Addrinfo の rb_define_class() と rdoc 用のコメントとのあいだに別の処理が入ってドキュメント化がミスっていたので修正しています。
[0601bce6fc] Nobuyoshi Nakada 2023-12-17 23:49:06 UTC
拡張ライブラリ socket の Socket::ResolutionError という例外クラスの rdoc 用コメントを追加しています。
[e14dddcaca] Yusuke Endoh 2023-12-15 15:25:00 UTC
NEWS のセクションの移動や末尾の空白除去。
[d8978445ae] Takashi Kokubun 2023-12-18 04:45:09 UTC
doc/yjit/yjit.md の YJIT のドキュメントを更新しています。
[83194aa27d] Takashi Kokubun 2023-12-18 05:14:23 UTC
GitHub Actions の check_mist という workflow のジョブに名前を明示的につけています。
[e8064c6c2c] Takashi Kokubun 2023-12-18 05:16:09 UTC
GitHub Actions の check_misc workflow の名前を Miscellaneous → Misc に変更しています。
[ba1d1522d3] Jean Boussier 2023-12-18 08:59:06 UTC
Object Shapes でインスタンス変数のバリエーションが多すぎて too_complex になった時の警告メッセージの英文を変更しています。initialize でインスタンス変数代入するなどアクセスする順番のバリエーションを減らすよう suggestion も追加しています。
[9abaf00c07] Nobuyoshi Nakada 2023-12-18 03:44:28 UTC
GC.garbage_collect や ObjectSpace.garbage_collect の rdoc 用コメントを追加しています。
[a94f3f206e] Nobuyoshi Nakada 2023-12-18 05:43:42 UTC
doc/rdoc/markup_reference.rb に rdoc の :nodoc: タグの使いかたについての注意書きを追加しています。
[9b00b2bfb2] Nobuyoshi Nakada 2023-12-18 10:42:57 UTC
File::Constants の配下の定数の rdoc 用コメントを追加しています。
[494e6b54ab] Nobuyoshi Nakada 2023-12-18 10:43:52 UTC
File の fnmatch 用の定数群の rdoc 用コメントを追加しています。
[e9b0b6015e] Nobuyoshi Nakada 2023-12-18 10:46:24 UTC
IO::READABLE, IO::WRITABLE, IO::PRIORITY などの定数の rdoc 用コメントを追加しています。
[835f1461f7] Nobuyoshi Nakada 2023-12-18 10:51:16 UTC
IO::Buffer#hexdump の rdoc 用コメントを追加しています。
[baf1403fba] Nobuyoshi Nakada 2023-12-18 10:52:06 UTC
拡張ライブラリ pty の PTY.getpty の定義を rb_define_module_function() でしている行の前の :nodoc: タグは効かないので preprocessor 分岐をしてビルドされない位置で rb_define_alias() で PTY.spawn の alias として定義している態で rdoc 用のコメントを追加しています。
[40fc9b070c] Nobuyoshi Nakada 2023-12-18 10:57:45 UTC
インタプリタの動作から内部的に呼ばれるメソッドや Object Shapes のデバッグ用のメソッドに rdoc のドキュメント化を抑制するための :nodoc: タグを明示的に書くようにしています。
[b2fc1b054e] Jean Boussier 2023-12-18 09:17:15 UTC
拡張ライブラリ socket の XxxSocket#recv_nonblock の rdoc 用コメントにメッセージが受信されなかった時に空文字列でなく nil を返すように記述を変更しています。確かこれ今年? 変更したんですよね。 https://github.com/ruby/ruby/pull/6407 [ruby-core:109961] [Bug #19012]
