Merge pull request rurema#3257 from znz/c-fix-remaining-dlist-indent

dlist 継続行の折り返しに残っていた1スペースインデントを2スペースにする

Author: znz

Rakefile

@@ -141,7 +141,7 @@ def generate_statichtml(version)
   raise "Failed to generate static html" unless succeeded
 end
 
-task :default => [:check_filename_case_conflicts, :check_indent_in_samplecode, :generate, :check_format]
+task :default => [:check_filename_case_conflicts, :check_indent_in_samplecode, :check_single_space_indent, :generate, :check_format]
 
 namespace :generate do
   ALL_VERSIONS.each do |version|
@@ -270,3 +270,52 @@ task :check_indent_in_samplecode do
     fail
   end
 end
+
+# #3246 で dlist（`- **term**:` の説明文）の継続行インデントを CommonMark
+# 準拠の2スペースに統一したが、同一段落内で折り返された物理行（直前行が
+# 2スペースインデントの本文で、その次の行）だけ半角スペース1個のまま
+# 取り残される回帰が #3255 で見つかった。直前行が2スペースの本文なのに
+# 当該行が1スペースなのは、ほぼ確実に同じ段落の折り返しが2スペースに
+# 揃え損ねたものなので、その形だけを対象に検出する（`- item` のような
+# リストマーカー行や、`- **term**:` 直後1行だけの説明のような、1スペース
+# のままでも正しく描画される既存の書き方は対象外）。
+desc 'Check dlist continuation lines use 2-space indent (not 1)'
+task :check_single_space_indent do
+  fence_re = /\A[ \t]*(`{3,}|~{3,})/
+  errors = []
+  Dir.glob('manual/**/*.md').sort.each do |path|
+    lines = File.read(path).lines(chomp: true)
+    in_fence = false
+    fence_char = nil
+    fence_len = 0
+    prev_line = nil
+    prev_was_fence = false
+    lines.each.with_index(1) do |line, lineno|
+      if (m = fence_re.match(line))
+        char, len = m[1][0], m[1].length
+        if !in_fence
+          in_fence = true
+          fence_char = char
+          fence_len = len
+        elsif char == fence_char && len >= fence_len
+          in_fence = false
+        end
+        prev_line = line
+        prev_was_fence = true
+        next
+      end
+      next if in_fence
+
+      if line =~ /\A [^ ]/ && !prev_was_fence && prev_line && prev_line =~ /\A {2}[^ ]/
+        errors << "#{path}:#{lineno}: dlist 継続行のインデントが半角スペース1個です。直前行と同じ2個にしてください"
+      end
+      prev_line = line
+      prev_was_fence = false
+    end
+  end
+
+  unless errors.empty?
+    puts errors
+    fail
+  end
+end

manual/api/_builtin/IO.md

@@ -80,10 +80,10 @@ IO オブジェクトは外部エンコーディングと内部エンコーデ
 - **外部エンコーディングのみが指定されている場合**:
 
   IO からテキスト読み込みメソッドによって読み込まれた文字列のエンコーディングは外部エンコーディング
- に設定されます。このとき実際の文字エンコーディングは検査されず、変換もされません。
+  に設定されます。このとき実際の文字エンコーディングは検査されず、変換もされません。
 
- IO へ書き込まれる文字列は外部エンコーディングへと変換されます。
- 外部エンコーディングへの変換方法が分からない場合は例外が発生します。
+  IO へ書き込まれる文字列は外部エンコーディングへと変換されます。
+  外部エンコーディングへの変換方法が分からない場合は例外が発生します。
 
 - **外部エンコーディングと内部エンコーディング(あるいは default_internal)が指定されている場合**:
  IO からテキスト読み込みメソッドによって読み込まれた文字列は、外部エンコーディングから
@@ -92,8 +92,8 @@ IO オブジェクトは外部エンコーディングと内部エンコーデ
  内部エンコーディングと  [m:Encoding.default_internal] が両方とも指定されている場合は、
  内部エンコーディングが優先されます。
 
- IO へ書き込まれる文字列は外部エンコーディングへと変換されます。
- 外部エンコーディングへの変換方法が分からない場合は例外が発生します。
+  IO へ書き込まれる文字列は外部エンコーディングへと変換されます。
+  外部エンコーディングへの変換方法が分からない場合は例外が発生します。
 
 
 IO に対してエンコーディングを指定する方法には、生成時に [m:IO.open] や [m:File.open] 

manual/api/_builtin/printf-format.md

@@ -31,8 +31,8 @@ Ruby には整数の大きさに上限がないので、%b, %B, %o, %x, %X
 - **`#`**:
 
   2進、8進、16進の指示子(b, B, o, x, X) ではそれぞれプレフィック
- スとして "0b", "0B", "0", "0x", "0X" を付加します。
- C 言語と同様引数が 0 の場合にはプレフィックスが付加されません。
+  スとして "0b", "0B", "0", "0x", "0X" を付加します。
+  C 言語と同様引数が 0 の場合にはプレフィックスが付加されません。
 
   ```ruby
   p sprintf("%#b", 10) #=> "0b1010"
@@ -43,7 +43,7 @@ Ruby には整数の大きさに上限がないので、%b, %B, %o, %x, %X
   p sprintf("%#X", 10) #=> "0XA"
   ```
 
- 浮動小数点数 (f, e, E, g, G) に対しては必ず出力に"."をつけます。
+  浮動小数点数 (f, e, E, g, G) に対しては必ず出力に"."をつけます。
 
   ```ruby
   p sprintf("%.0f", 10) #=> "10"
@@ -52,7 +52,7 @@ Ruby には整数の大きさに上限がないので、%b, %B, %o, %x, %X
   p sprintf("%#.0e", 10) #=> "1.e+01"
   ```
 
- また g, G では上記に加えて末尾の余分な0が残ります。
+  また g, G では上記に加えて末尾の余分な0が残ります。
 
   ```ruby
   p sprintf("%.05g", 10) #=> "10"
@@ -62,11 +62,11 @@ Ruby には整数の大きさに上限がないので、%b, %B, %o, %x, %X
 - **`+`**:
 
   出力文字列を符号付きにします。特に正の数では`+`が付加されます。
- 数値の指示子
- (d, i, b, B, o, x, X, u, f, e, E, g, G)
- に対してだけ意味を持ちます。
- また、特に b, B, o, x, X, u に対しては、負数に対して "-"
- を付加することを示します。
+  数値の指示子
+  (d, i, b, B, o, x, X, u, f, e, E, g, G)
+  に対してだけ意味を持ちます。
+  また、特に b, B, o, x, X, u に対しては、負数に対して "-"
+  を付加することを示します。
 
   ```ruby
   p sprintf("%d", 1)   #=> "1"
@@ -79,8 +79,8 @@ Ruby には整数の大きさに上限がないので、%b, %B, %o, %x, %X
 - **' '(スペース)**:
 
   `+` と同じですが正の符号 `+` の代わりに空白を用います。数値の指示子
- (d, i, b, B, o, x, X, u, f, e, E, g, G)
- に対してだけ意味を持ちます。
+  (d, i, b, B, o, x, X, u, f, e, E, g, G)
+  に対してだけ意味を持ちます。
   ```ruby
   p sprintf("%d", 1)   #=> "1"
   p sprintf("%+d", 1)  #=> "+1"
@@ -94,33 +94,33 @@ Ruby には整数の大きさに上限がないので、%b, %B, %o, %x, %X
 - **`-`**:
 
   出力を左詰めにします。幅の指定がなければ
- 意味がありません。
+  意味がありません。
 
 - **`0`**:
 
   出力が右詰めの場合に余った部分に空白の代わりに "0" を詰めます。
 
- 数値の指示子の一部(d, i, b, B, o, x, X, u, f, g, G)に対し
- てだけ意味を持ちます(e, E には意味がない)
+  数値の指示子の一部(d, i, b, B, o, x, X, u, f, g, G)に対し
+  てだけ意味を持ちます(e, E には意味がない)
   ```ruby
   p sprintf("%010d", 10)   #=> "0000000010"
   ```
- `#` と一緒に指定した場合の出力は以下のようになります。
+  `#` と一緒に指定した場合の出力は以下のようになります。
   ```ruby
   p sprintf("%#010x", 10)  #=> "0x0000000a"
   p sprintf("%#010o", 10)  #=> "0000000012"
   p sprintf("%#010b", 10)  #=> "0b00001010"
   ```
 
- これは、以下と同じです。
+  これは、以下と同じです。
 
   ```ruby
   p sprintf("%#10.8x", 10) #=> "0x0000000a"
   p sprintf("%#10.9o", 10) #=> "0000000012"
   p sprintf("%#10.8b", 10) #=> "0b00001010"
   ```
 
- 通常は、以下のようになります。
+  通常は、以下のようになります。
 
   ```ruby
   p sprintf("%#10x", 10)   #=> "       0xa"
@@ -219,21 +219,21 @@ p sprintf("%.*s", 5, "foobar") #=> "fooba"
 - **`c`**:
 
   引数の数値(0〜255)を文字コードとみなして対応する文字を出力します。
- 引数が数値以外のオブジェクトの場合 to_int メソッドによる変換を試みます。
- 引数として範囲内の一文字の文字列も受けつけます。文字そのものを出力します。
+  引数が数値以外のオブジェクトの場合 to_int メソッドによる変換を試みます。
+  引数として範囲内の一文字の文字列も受けつけます。文字そのものを出力します。
   ```ruby
   p sprintf("%c", 97)  #=> "a"
   p sprintf("%c", 'a') #=> "a"
   ```
 
- フラグ `-` と幅 の指定だけが意味を持ちます。
+  フラグ `-` と幅 の指定だけが意味を持ちます。
 
 - **`s`**:
 
   文字列を出力します。
 
- 引数が [c:String] オブジェクトでなければ to_s メソッドにより文字列化
- したものを引数として扱います。
+  引数が [c:String] オブジェクトでなければ to_s メソッドにより文字列化
+  したものを引数として扱います。
 
 - **`p`**:
 
@@ -249,8 +249,8 @@ p sprintf("%.*s", 5, "foobar") #=> "fooba"
 
   引数の数値を10進表現の整数として出力します。
 
- 引数が整数でなければ関数 [m:Kernel?.Integer] と同じ規則で整数に
- 変換されます。
+  引数が整数でなければ関数 [m:Kernel?.Integer] と同じ規則で整数に
+  変換されます。
 
   ```ruby
   p sprintf("%d", -1) #=> "-1"
@@ -280,11 +280,11 @@ p sprintf("%.*s", 5, "foobar") #=> "fooba"
 
   整数をそれぞれ2進、2進(大文字)、8進、16進、16進(大文字)表現の文字列で出力します。
 
- `#` フラグを指定すれば "0b", "0B", "0", "0x", "0X" を先頭に付加します。
+  `#` フラグを指定すれば "0b", "0B", "0", "0x", "0X" を先頭に付加します。
 
- `+`, \` ' フラグがない場合、負の数には ".." が先頭(`#` フラグがあれば 
- "0x" などの後)に付加されます。これは最上位桁の文字が無限に続くことを
- 意味し、2の補数表現で負の数を表しています。
+  `+`, \` ' フラグがない場合、負の数には ".." が先頭(`#` フラグがあれば 
+  "0x" などの後)に付加されます。これは最上位桁の文字が無限に続くことを
+  意味し、2の補数表現で負の数を表しています。
 
   ```ruby
   p sprintf("%#b", 10)    #=> "0b1010"
@@ -315,13 +315,13 @@ p sprintf("%.*s", 5, "foobar") #=> "fooba"
 
   f は小数点表現(xxx.xxx)で数値を出力します。
 
- e は指数表現(x.xxxe+xx)で数値を出力します。
+  e は指数表現(x.xxxe+xx)で数値を出力します。
 
- g は 指数が -4 より小さいか精度以上の場合に e と同じ出力を、それ以
- 外では f と同じ出力を行います。ただし、小数部の末尾の0は取り除かれ
- ます。
+  g は 指数が -4 より小さいか精度以上の場合に e と同じ出力を、それ以
+  外では f と同じ出力を行います。ただし、小数部の末尾の0は取り除かれ
+  ます。
 
- a, A は指数表現の16進数("-h.hhh±pd") で数値を出力します。ただし、[m:Float::INFINITY]、[m:Float::NAN] はそれぞれ 'Inf'、'NaN' になります。詳しくは [ruby-dev:40650] を参照してください。
+  a, A は指数表現の16進数("-h.hhh±pd") で数値を出力します。ただし、[m:Float::INFINITY]、[m:Float::NAN] はそれぞれ 'Inf'、'NaN' になります。詳しくは [ruby-dev:40650] を参照してください。
 
   ```ruby
   p sprintf("%a", -0.0)            # => "-0x0p+0"
@@ -330,7 +330,7 @@ p sprintf("%.*s", 5, "foobar") #=> "fooba"
   ```
 
 
- 大文字の指示子(E, G)は出力のアルファベットを大文字にします。
+  大文字の指示子(E, G)は出力のアルファベットを大文字にします。
   ```ruby
   p sprintf("%f", 1.0) #=> "1.000000"
   p sprintf("%e", 1.0) #=> "1.000000e+00"
@@ -343,9 +343,9 @@ p sprintf("%.*s", 5, "foobar") #=> "fooba"
   p sprintf("%g", 10 ** 6)  #=> "1e+06"
   p sprintf("%g", 10 ** -5) #=> "1e-05"
   ```
- 精度の省略値は 6 です。
+  精度の省略値は 6 です。
 
- 無限大、NaN(Not a Number) に対する出力は以下のとおりです。
+  無限大、NaN(Not a Number) に対する出力は以下のとおりです。
   ```ruby
   p sprintf("%f",  1.0/0)  #=> "inf"
   p sprintf("%f", -1.0/0)  #=> "-inf"
@@ -355,8 +355,8 @@ p sprintf("%.*s", 5, "foobar") #=> "fooba"
   p sprintf("%E", -1.0/0)  #=> "-INF"
   p sprintf("%E",  0.0/0)  #=> "NAN"
   ```
- f, e, E, g, G に関しては [man:sprintf(3)] の結果を利用しています。従って出力結果は
- 実際にはシステムに依存することになります。
+  f, e, E, g, G に関しては [man:sprintf(3)] の結果を利用しています。従って出力結果は
+  実際にはシステムに依存することになります。
 
 ### 引数指定
 
@@ -371,8 +371,8 @@ p sprintf("%.*s", 5, "foobar") #=> "fooba"
 
   p sprintf("%1$d, %1$x, %1$o", 10) #=> "10, a, 12"
   ```
- 状況によってフォーマットを変えたいが引数の順序を変えたくない場合に使
- 用します。
+  状況によってフォーマットを変えたいが引数の順序を変えたくない場合に使
+  用します。
   ```ruby
   case ENV['LC_TIME']
   when /^ja_JP/
@@ -383,8 +383,8 @@ p sprintf("%.*s", 5, "foobar") #=> "fooba"
 
   p sprintf(fmt, 1, 4, 22) #=> "04/22/01"
   ```
- "*" の後に指定することで幅や
- 精度を引数で指定することもできます。
+  "*" の後に指定することで幅や
+  精度を引数で指定することもできます。
   ```ruby
   p sprintf("%5.2f", 1)              #=> " 1.00"
   p sprintf("%*.*f", 5, 2, 1)        #=> " 1.00"
@@ -394,16 +394,16 @@ p sprintf("%.*s", 5, "foobar") #=> "fooba"
 - **`%<name>`**:
 
   Symbol のインスタンス name をキーとする Hash を引数にした場合、
- 対応する値をフォーマットして参照します。
+  対応する値をフォーマットして参照します。
   ```ruby
   p sprintf('%<foo>f : %<bar>+d', foo: 1, bar: 2) #=> "1.000000 : +2"
   ```
 
 - **`%{name}`**:
 
   Symbol のインスタンス name をキーとする Hash を引数にした場合、
- 対応する値をフォーマットせずに参照します。
- 幅や精度を指定するために使用できます。
+  対応する値をフォーマットせずに参照します。
+  幅や精度を指定するために使用できます。
   ```ruby
   p sprintf('%{foo}f : %{bar}+d', foo: 1, bar: 2) #=> "1f : 2+d"
   ```

manual/api/openssl/OpenSSL__BN.md

@@ -33,8 +33,8 @@ base で、変換方法(基数)を指定します。
 - **0**:
 
   引数の文字列を MPI形式の文字列(バイト列)とみなして、変換します
- (最初の4byteはbig-endianでデータ長を表わし、その後にそのデータ長のバイト列
- (big-endian)で数値を表す。最上位ビットが立っていると負数)。
+  (最初の4byteはbig-endianでデータ長を表わし、その後にそのデータ長のバイト列
+  (big-endian)で数値を表す。最上位ビットが立っていると負数)。
 
 ```ruby
 require 'openssl'

manual/api/optparse/OptionParser.md

@@ -34,8 +34,8 @@ opts.parse!(ARGV)                            # 実際にコマンドラインの
 - **`--version`**:
 
   [m:OptionParser#ver] を表示してから exit します。
- [m:OptionParser#ver] が定義されていない場合は、そのようにエラーメッセージを出力して abort します。
- オプション「--version」に「,」で区切られたクラス名かモジュール名を引数として与えた場合は、そのクラスおよびモジュールで定義されている定数「Version」および「Release」を表示して、終了します。
+  [m:OptionParser#ver] が定義されていない場合は、そのようにエラーメッセージを出力して abort します。
+  オプション「--version」に「,」で区切られたクラス名かモジュール名を引数として与えた場合は、そのクラスおよびモジュールで定義されている定数「Version」および「Release」を表示して、終了します。
   ```
    $ ruby t.rb --version=OptionParser,URI,OpenSSL
    t: OptionParser version 12203 (2007-04-20)