Skip to content

Commit 6102f55

Browse files
znzclaude
andcommitted
Address findings #4/#6/#9: dlist spacing, empty @raise, old-style quote
bitclust doc/markdown-findings.md のフォローアップのうち doctree 記述3件: - #4: spec/operator.rd の「:再定義できない演算子」にスペースを追加 (dlist 開始/継続の非対称に依存しない正規形へ。描画は不変) - #6: 説明なし・末尾スペースの @raise を整備 - openssl/Random の egd/egd_bytes に「EGD からのエントロピー取得に 失敗した場合に発生します。」を追記 - 孤立した重複 @raise 2行(egd_bytes 直後・load_random_file の2つ目)を削除 - rubygems/remote_fetcher.rd の download に「Gem の取得に失敗した場合に 発生します。」を追記 - #9: platform/DOSISH-support.rd の GNU 風引用 `\' を「\」に書き換え manual/ は同変更を再生成で反映(3ファイル)。 検証: roundtrip 1245/1245、rake generate 3.0〜4.1 全7版成功、 statichtml 全7版で UNKNOWN_META_INFO 0・compileerror 0、 check_indent_in_samplecode green。 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 365329e commit 6102f55

7 files changed

Lines changed: 9 additions & 15 deletions

File tree

manual/api/openssl/Random.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ filename で指定した Unix domain socket から EGD に問い合わせ、
7474
[m:OpenSSL::Random.egd_bytes](filename, 255) と同じです。
7575

7676
- **param** `filename` -- EGD のソケットのファイル名
77-
- **raise** `OpenSSL::Random::RandomError` --
77+
- **raise** `OpenSSL::Random::RandomError` -- EGD からのエントロピー取得に失敗した場合に発生します。
7878

7979
### module_function def egd_bytes(filename, length) -> true
8080
EGD(Entropy Gathering Daemon) から length バイト分のエントロピーを得ます。
@@ -84,11 +84,9 @@ filename で指定した Unix domain socket から EGD に問い合わせ、
8484

8585
- **param** `filename` -- EGD のソケットのファイル名
8686
- **param** `length` -- 読み込むバイト数
87-
- **raise** `OpenSSL::Random::RandomError` --
87+
- **raise** `OpenSSL::Random::RandomError` -- EGD からのエントロピー取得に失敗した場合に発生します。
8888

8989

90-
- **raise** `OpenSSL::Random::RandomError` --
91-
9290
### module_function def load_random_file(filename) -> true
9391
ファイルを読み込み、その内容をエントロピー源として
9492
乱数生成器に渡します。
@@ -99,7 +97,6 @@ OpenSSL::Random.seed(File.read(filename)) と同じです。
9997

10098
- **param** `filename` -- 読み込むファイル名
10199
- **raise** `OpenSSL::Random::RandomError` -- ファイルの読み込みに失敗した場合に発生します
102-
- **raise** `OpenSSL::Random::RandomError` --
103100

104101
### module_function def pseudo_bytes(len) -> String
105102
暗号論的な予測不可能性を持たない(が高速な)

manual/api/rubygems/remote_fetcher/Gem__RemoteFetcher.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ source_uri から取得した Gem パッケージをキャッシュディレク
3030

3131
- **return** -- ローカルにコピーした Gem ファイルのパスを返します。
3232

33-
- **raise** `Gem::RemoteFetcher::FetchError` --
33+
- **raise** `Gem::RemoteFetcher::FetchError` -- Gem の取得に失敗した場合に発生します。
3434

3535
### def fetch_path(uri, mtime = nil, head = false) -> String | Hash
3636

manual/doc/platform/DOSISH-support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ruby version 1.7 では、DOSISH対応(DOS/Windows のパス名の扱いに対
1111
とりあえずの目標として、
1212

1313
- \ も / と同様パスセパレータとして扱う
14-
- マルチバイトパス名への対応("表" など 2 byte 目が 0x5c(\`\') である文字を正しく扱う)
14+
- マルチバイトパス名への対応("表" など 2 byte 目が 0x5c(「\」)である文字を正しく扱う)
1515
- UNC 対応(これ自体は1.6にも入っている)
1616
- ドライブレター対応
1717

refm/api/src/openssl/Random

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ filename で指定した Unix domain socket から EGD に問い合わせ、
7171
[[m:OpenSSL::Random.egd_bytes]](filename, 255) と同じです。
7272

7373
@param filename EGD のソケットのファイル名
74-
@raise OpenSSL::Random::RandomError
74+
@raise OpenSSL::Random::RandomError EGD からのエントロピー取得に失敗した場合に発生します。
7575

7676
--- egd_bytes(filename, length) -> true
7777
EGD(Entropy Gathering Daemon) から length バイト分のエントロピーを得ます。
@@ -81,11 +81,9 @@ filename で指定した Unix domain socket から EGD に問い合わせ、
8181

8282
@param filename EGD のソケットのファイル名
8383
@param length 読み込むバイト数
84-
@raise OpenSSL::Random::RandomError
84+
@raise OpenSSL::Random::RandomError EGD からのエントロピー取得に失敗した場合に発生します。
8585

8686

87-
@raise OpenSSL::Random::RandomError
88-
8987
--- load_random_file(filename) -> true
9088
ファイルを読み込み、その内容をエントロピー源として
9189
乱数生成器に渡します。
@@ -96,7 +94,6 @@ OpenSSL::Random.seed(File.read(filename)) と同じです。
9694

9795
@param filename 読み込むファイル名
9896
@raise OpenSSL::Random::RandomError ファイルの読み込みに失敗した場合に発生します
99-
@raise OpenSSL::Random::RandomError
10097

10198
--- pseudo_bytes(len) -> String
10299
暗号論的な予測不可能性を持たない(が高速な)

refm/api/src/rubygems/remote_fetcher.rd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ source_uri から取得した Gem パッケージをキャッシュディレク
3030

3131
@return ローカルにコピーした Gem ファイルのパスを返します。
3232

33-
@raise Gem::RemoteFetcher::FetchError
33+
@raise Gem::RemoteFetcher::FetchError Gem の取得に失敗した場合に発生します。
3434

3535
--- fetch_path(uri, mtime = nil, head = false) -> String | Hash
3636

refm/doc/platform/DOSISH-support.rd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ruby version 1.7 では、DOSISH対応(DOS/Windows のパス名の扱いに対
1111
とりあえずの目標として、
1212

1313
* \ も / と同様パスセパレータとして扱う
14-
* マルチバイトパス名への対応("" など 2 byte 目が 0x5c(`\') である文字を正しく扱う)
14+
* マルチバイトパス名への対応("" など 2 byte 目が 0x5c(「\」)である文字を正しく扱う)
1515
* UNC 対応(これ自体は1.6にも入っている)
1616
* ドライブレター対応
1717

refm/doc/spec/operator.rd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ a || b && c #=> a || (b && c)
7373
これらの演算子式の定義方法については[[ref:d:spec/def#operator]]を参照してください。
7474
#@end
7575

76-
:再定義できない演算子(制御構造)
76+
: 再定義できない演算子(制御構造)
7777

7878
#@until 1.9.0
7979
演算子の組合せである自己代入演算子と !=, !~

0 commit comments

Comments
 (0)