Scala API、特にコレクションには、メソッド シグネチャが間違っている場所がたくさんあります。
たとえば、Mapの scaladoc 署名。flatMap言う
def flatMap[B](f: (A) ⇒ GenTraversableOnce[B]): Map[B]
でも実際のサインは
flatMap[B, That](f: ((A, B)) ⇒ GenTraversableOnce[B])
(implicit bf: CanBuildFrom[Map[A, B], B, That]): That
scaladoc シグネチャにはMap[B]が含まれMapていますが、1 つではなく 2 つの型パラメーターがあるため、これは特に意味がありません。
何が起きてる？これは間違いですか？
生成されたドキュメントに表示される誤った署名は、「ユース ケース」と呼ばれます。彼らは、理想化された API を示すことによってドキュメントを明確にすることになっています。実際の API に似ていますが、退屈な詳細 (一部の人々を悩まCanBuildFromせる普及している暗黙のパラメーターなど) は省略しています。
ユースケースのあるメソッドの場合、メソッド名をクリックしてそのメソッドの詳細を表示し、[完全な署名] をクリックして署名を表示する別のセクションを展開すると、実際の署名にアクセスできます。
2010 年 5 月に作成されたScala の問題 SI-3448は、特に に表示される型パラメータの数が間違っていることを扱っていますMap。この問題は、2012 年 7 月に「修正されません」としてクローズされました。
Paul Phillips の講演Scala Collections: Why Not? 2014 年 1 月から、スライド 1、スライド 2、スライド 3のユース ケースを「嘘」として軽蔑します。
GenTraversableLike.scala では、ユース ケース ドキュメントを生成するディレクティブの例を確認できます。
@usecase def flatMap[B](f: A => TraversableOnce[B]): $Coll[B]