scala / bug

Scala 2 bug reports only. Please, no questions — proper bug reports only.
https://scala-lang.org
232 stars 21 forks source link

[usecase] appears to label following text not preceding method signature #9533

Closed scabug closed 8 months ago

scabug commented 9 years ago

The [use case] label is more likely to be interpreted as a header for the following text than an indication the method signature is a simplified version.

!scaladoc-usecase-misleading.png!

In this the use case could be taken to be Multiples up the elements ... .

Replacing [use case] with Full Signature would be a twofold improvement,

If use case had to remain in some form then simplified signature would be an improvement.

|As a further illustration the problem is excerbated when the document block is collapsed|!scaladoc-usecase-misleading-collapsed.png!|

scabug commented 9 years ago

Imported From: https://issues.scala-lang.org/browse/SI-9533?orig=1 Reporter: @janekdb Affected Versions: 2.11.7 Attachments:

SethTisue commented 8 months ago

@usecase was deprecated in 2.13.0 (and all usages were removed from stdlib)