docs: apply snippet compiler on new types reference docs #19513

i10416 · 2024-01-22T19:26:14Z

This commit addresses a part of #12967.

To make documents pass snippet checking, I modified some Scala code blocks while keeping original code as much as possible.

I guessed snippet check for docs raises "dotty.tools.dotc.MissingCoreLibraryException: Could not find package scala from compiler core libraries." on CI ~~(not on my local machine)~~, so I skipped adding docs to Build.scala, but it still fails 🤔

This commit addresses a part of scala#12967. To make documents pass snippet checking, I modified some Scala code blocks while keeping original code as much as possible. Snippet check for docs raises "dotty.tools.dotc.MissingCoreLibraryException: Could not find package scala from compiler core libraries." on CI(not on my local machine), so I skip adding docs to Build.scala for now.

i10416 · 2024-01-22T19:46:23Z

Even when I do not change Build.scala, it fails 🤔

dotty.tools.dotc.MissingCoreLibraryException: Could not find package scala from compiler core libraries.
Make sure the compiler core libraries are on the classpath.

https://github.com/lampepfl/dotty/actions/runs/7616330659/job/20742843404?pr=19513

docs/_docs/reference/new-types/match-types.md

docs/_docs/reference/new-types/polymorphic-function-types.md

docs/_docs/reference/new-types/dependent-function-types.md

undo unnecessary changes

docs/_docs/reference/new-types/union-types.md

i10416 · 2024-01-23T09:22:27Z

I believe snippet checking has not been applied to docs/_docs/*. Why minor changes to code and code block metadata in docs result in error?

Before this commit, `generateReferenceDocumentation` failed with MissingCoreLibraryException even though it didn't use snipet checking. It turned out that `sc:fail` causes the problem, but I do not know exact reason for this. Nothing but snippet compiler should use the `sc:fail` metadata.

i10416 · 2024-01-23T09:48:30Z

It turned out that sc:fail causes the problem, but I do not know exact reason for this.
I believe generateReferenceDocumentation task hasn't used snippet compiler on documents. Otherwise, generateReferenceDocumentation should have always failed. Nevertheless, The presence of sc:fail causes the dotty.tools.dotc.MissingCoreLibraryException.

The change in unin-types-spec.md is workaround. It should be `sc:fail` instead of `sc:nocompile`, but it causes generateReferenceDocumentation task to fail with MissingCoreLibraryException.

This commit adds workaround for the MissingCoreLibraryException due to `sc:fail` and enables snippet compiler on enums reference documents. See scala#19513 (comment)

project/Build.scala