scaladoc does not include members of nested classes/traits/objects

[coreyoconnor]

reproduction steps

Search for the method in in the generated documentation: https://www.scalatest.org/scaladoc/3.2.0/index.html

Note: This is not specific to scalatest; just used as a convenient example.

problem

I'd expect to be able to find the in method. This is not the case. From a quick survey, this presents a difficulty for users of scaladoc:

• https://twitter.com/QueueQueueHack/status/1281285760650407936

(There are other issues reference by that link. Those will be covered with separate tickets)

[Jasper-M]

Searching for to in the standard library docs works though. The UX when there are many results could still be better of course.

[coreyoconnor]

Updated to be specific to "in" perhaps that's filtered for other reasons?

[forketyfork]

Quick investigation shows that in method always occurs in nested traits, e.g. FixtureAnyFlatSpecLike.ItVerbString. The search index is generated at build time, and it doesn't contain members of nested classes/traits/objects, only members of top level entities.

Probably the solution would be to add members of nested classes to the index, however, this may significantly increase its size.

BTW you can search for precise names of short methods using regular expressions, e.g. ^to$.

[som-snytt]

An example in standard lib is asJava, for example in IteratorHasAsJava. In Scala 3, the method results box offers "show more", and the iterator result type is at top and also down the list for the nested implicit class.

Scala 2 omits the nested results, as OP said.

Dottydoc does nice camel case search, e.g., JLo for AsJavaLongConsumer, AsJavaIntToLongFunction, etc.

It would be nice to sort by nesting level, hi->lo or lo->hi.

[som-snytt]

Just noticed that this ticket is from a couple of years ago, so I won't reply on twitter after all. It's not even called twitter anymore!