scala / scala3

The Scala 3 compiler, also known as Dotty.
https://dotty.epfl.ch
Apache License 2.0
5.81k stars 1.05k forks source link

Experimental definitions in scaladoc #16440

Open nicolasstucki opened 1 year ago

nicolasstucki commented 1 year ago

Compiler version

3.3.0-RC1-bin-20221128-8fba321-NIGHTLY

Issue

Generated docs do not indicate if a definition is experimental. All definitions are shown the same.

Expectation

At least we should explicitly mark which definitions are experimental.

We should also have a way to filter them out with a toggle. These should not be shown by default as most programmers will not be able to use them.

Example

Screenshot 2022-11-30 at 09 04 15
prolativ commented 1 year ago

I think we've already discussed this and the conclusion was that @experimental definitions should be marked in a similar way to @deprecated

szymon-rd commented 1 year ago

Addressed in #16310 (new section)