Es gibt viele Orte in der Scala-API , insbesondere in Sammlungen, in denen Methodensignaturen falsch sind .
Zum Beispiel die scaladoc-Signatur für Map . flatMap
sagt
Aber die tatsächliche Signatur ist
%Vor% Dies macht besonders keinen Sinn, weil die Scaladoc-Signatur Map[B]
enthält, aber Map
hat zwei Typparameter, nicht einen.
Was ist hier los? Ist das ein Fehler?
Die falschen Signaturen, die Sie in der generierten Dokumentation sehen, werden "Anwendungsfälle" genannt. Sie sollen die Dokumentation verdeutlichen, indem sie eine idealisierte API zeigen, die der echten ähnlich ist, aber langweilige Details auslässt (wie das implizite implizite CanBuildFrom
Parameter, der stört einige Leute ).
Bei Methoden mit Anwendungsfällen können Sie zur eigentlichen Signatur gelangen, indem Sie auf den Methodennamen klicken, um die Details für diese Methode anzuzeigen, und dann auf "Vollständige Signatur" klicken, um einen anderen Abschnitt mit der Signatur zu erweitern.
Scala-Problem SI-3448 , erstellt im Mai 2010, behandelt speziell die falsche Nummer von Typparametern, die für Map
angezeigt werden. Dieses Problem wurde im Juli 2012 als "Nicht behoben" behoben.
Paul Phillips 'Gespräch Scala Collections: Warum nicht? ab Januar 2014 verunglimpft die Anwendungsfälle als "Lügen" in Folie 1 , Folie 2 , Folie 3 .
In GenTraversableLike.scala Sie kann ein Beispiel für eine Direktive sehen, die zur Generierung einer Use-Case-Dokumentation führt:
%Vor%