Skip to content

Scala3doc: document sconfig in community build #10652

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions community-build/src/scala/dotty/communitybuild/projects.scala
Original file line number Diff line number Diff line change
Expand Up @@ -346,9 +346,7 @@ object projects:
lazy val sconfig = SbtCommunityProject(
project = "sconfig",
sbtTestCommand = "sconfigJVM/test",
// sbtDocCommand = "sconfigJVM/doc", // Fails with:
// Problem parsing sconfig/sharedScala3/src/main/scala/org/ekrich/config/ConfigSyntax.scala:[73..92..1340], documentation may not be generated.
// scala.MatchError: ValDef(JSON,TypeTree[TypeRef(TermRef(ThisType(TypeRef(NoPrefix,module class ekrich)),module config),class ConfigSyntax)],Apply(Ident($new),List(Literal(Constant(0)), Literal(Constant(JSON))))) (of class dotty.tools.dotc.ast.Trees$ValDef)
sbtDocCommand = "sconfigJVM/doc",
)

lazy val zio = SbtCommunityProject(
Expand Down Expand Up @@ -409,7 +407,7 @@ object projects:
// [error] Caused by: java.lang.AssertionError: assertion failed:
// trait MonadIO has non-class parent: AppliedType(TypeRef(TermRef(ThisType(TypeRef(NoPrefix,module class <root>)),module scalaz),Monad),List(TypeRef(ThisType(TypeRef(TermRef(ThisType(TypeRef(NoPrefix,module class scalaz)),module effect),trait MonadIO)),type F)))

// sbtDocCommand = forceDoc("iterateeJVM"), // Fails with
// forceDoc("iterateeJVM"), // Fails with
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why we do need to change that?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I accidentally added this one. It's slightly easier to test the different doc commands if it's like this since it matches the previous paragraph.

// [error] class scalaz.iteratee.Iteratee cannot be unpickled because no class file was found

sbtDocCommand = forceDoc("effectJVM"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@ object FromSymbol {
else if (sym.isType && sym.is(Case)) typeBindFromSym(sym.asType)
else if (sym.isType) typeDefFromSym(sym.asType)
else if (sym.is(Method)) defDefFromSym(sym.asTerm)
else if (sym.is(ModuleVal)) valDefFromSym(sym.asTerm)
else if (sym.is(Case)) bindFromSym(sym.asTerm)
else if (sym.is(Case, butNot = ModuleVal | EnumVal)) bindFromSym(sym.asTerm)
else valDefFromSym(sym.asTerm)
}

Expand Down