Skip to content

Fix snippets in Scala 3 documentation #12967

Open
@pikinier20

Description

@pikinier20

Summary

<style type="text/css"></style>

Location Count
scala.quoted 26
scala.compiletime 6
scala 1
blog/_posts 28
docs/contributing 5
docs/internals 9
docs/reference/changed-features 19
docs/reference/contextual 16
docs/reference/dropped-features 11
docs/reference/enums 3
docs/reference/experimental 3
docs/reference/metaprogramming 7
docs/reference/new-types 9
docs/reference/other-new-features 20
docs/usage 4
docs/release-notes 1

Instruction

  1. Find generateScalaDocumentation task in Build.scala
  2. Find generateDocumentation call inside task definition
  3. Add the part of documentation that you want to fix to snippet compiler setting (You can find usage here)
  4. Path to scala3 library is stored in dottyLibRoot variable
  5. E.g. if you want to run snippet compiler on scala.quoted, add $dottyLibRoot/scala/quoted=compile
  6. If you want to run snippet compiler on docs/contributing, add docs/docs/contributing=compile
  7. Fix all failing snippets or override snippet compiler flag if it's necessary.
  8. You can override flag by adding sc:flag after "```scala" in snippet.
  9. You can hide piece of code by doing:
//{
def someHiddenCode = ???
//}
  1. Create PR to master.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions