Order of parameter descriptions in Scaladoc


The new Scaladoc is very nice in many ways, but has some rough edges still.

Today, I noticed that, to my surprise, descriptions of parameters get sorted alphabetically rather than being listed in declaration order. Example: indexWhere’s second parameter, from, is listed before the first, p.

This feels confusing. I wonder if this is intentional for some reason, or just a bug. The same did not happen in Scala 2.

(indexWhere is also an example of default parameter values not getting documented any more, BTW. And the link from the doc to StringOps.scala is broken.)

1 Like