Scala3doc: Add missing givens, create pages for givens, minor bugfixes #10306
Conversation
pikinier20
changed the title
| @@ -111,25 +111,55 @@ trait ClassLikeSupport: | |||
| val target = ExtensionTarget(extSym.symbol.name, extSym.tpt.dokkaType.asSignature, extSym.tpt.symbol.dri) | |||
| parseMethod(dd.symbol, kind = Kind.Extension(target)) | |||
| } | |||
|
|
|||
| // TODO check given methods? | |||
There was a problem hiding this comment.
Maybe we can check given methods as part of this PR?
| case dd: DefDef if !dd.symbol.isHiddenByVisibility && dd.symbol.isGiven => | ||
| Some(parseMethod(dd.symbol, kind = Kind.Given(getGivenInstance(dd).map(_.asSignature), None))) // TODO check given methods? | ||
| Some(dd.symbol.owner.typeMember(dd.name)) |
There was a problem hiding this comment.
Can dd.symbol.owner.typeMember(dd.name) be a null? If not then simple if will be nicer to read:
if dd.symbol.owner.typeMember(dd.name).exisits then None
else Some(parseMethod(dd.symbol, kind = Kind.Given(getGivenInstance(dd).map(_.asSignature), None)))
|
|
||
| case dd: DefDef if !dd.symbol.isHiddenByVisibility && !dd.symbol.isGiven && !dd.symbol.isSyntheticFunc && !dd.symbol.isExtensionMethod => | ||
| Some(parseMethod(dd.symbol)) | ||
|
|
||
| case td: TypeDef if !td.symbol.flags.is(Flags.Synthetic) && (!td.symbol.flags.is(Flags.Case) || !td.symbol.flags.is(Flags.Enum)) => | ||
| Some(parseTypeDef(td)) | ||
|
|
||
| case vd: ValDef if !isSyntheticField(vd.symbol) | ||
| && (!vd.symbol.flags.is(Flags.Case) || !vd.symbol.flags.is(Flags.Enum)) |
There was a problem hiding this comment.
maybe we can exctract all this conditions to dedicated method?
| case t: TypeTree => Some(t.tpe) | ||
| case _ => None | ||
| } | ||
| val modifiedClasslikeExtension = ClasslikeExtension.getFrom(parsedClasslike).map(_.copy( |
There was a problem hiding this comment.
if you first call get and then copy you can get rid of map
| @@ -238,6 +268,7 @@ trait ClassLikeSupport: | |||
| val name = methodKind match | |||
| case Kind.Constructor => "this" | |||
| case Kind.Given(_, _) => methodSymbol.name.stripPrefix("given_") | |||
| case Kind.Extension(_) => methodSymbol.name.stripPrefix("extension_") | |||
There was a problem hiding this comment.
This should no longer be necessary, the encoding of extension methods has changed and their names AFAIU are no longer prefixed with extension_.
There was a problem hiding this comment.
In the version of master that this PR was based on, there were still extension_ prefixes before every extension.
| Kind.Implicit(Kind.Val, extractImplicitConversion(valDef.tpt.tpe)) | ||
| else defaultKind | ||
| else defaultKind |
There was a problem hiding this comment.
Without indent there, I've got:
[error] 373 | else defaultKind
[error] | ^
[error] |The start of this line does not match any of the previous indentation widths.
| @@ -17,13 +17,13 @@ class ImplicitMembersExtensionTransformer(ctx: DokkaContext) extends Documentabl | |||
|
|
|||
| def expandMember(outerMembers: Seq[Member])(c: Member): Member = | |||
| val companion = c match | |||
| case classlike: DClass => ClasslikeExtension.getFrom(classlike).flatMap(_.companion).map(classlikeMap) | |||
| case classlike: DClass => ClasslikeExtension.getFrom(classlike).flatMap(_.companion).flatMap(classlikeMap.get) | |||
There was a problem hiding this comment.
Is it expected that classlikeMap would miss some classlikes?
There was a problem hiding this comment.
ahh, actually I changed it on the beginning of implementing this PR because it was throwing exceptions, but I've checked and this change is unnecessary
| case Kind.Given(Some(instance), _) => withGenerics | ||
| .text(" as ") | ||
| .signature(instance) | ||
| case _ => withGenerics |
There was a problem hiding this comment.
Shouldn't we have tests for this?
There was a problem hiding this comment.
It's actually tested by givenSignatures as we had these signatures documented, but in different way (we were generating signature from DFunction instead of DClass).
There was a problem hiding this comment.
Some style-related comment. @abgruszecki asked some good questions
|
It seems that in the meantime grouping of extension methods broke, regrettably: https://scala3doc.virtuslab.com/pr-10306/scala3/api/scala/opaques/array-ops/index.html Once this is merged we should open a separate issue for that problem. |
|
We've decided to create a follow up PR with all the fixes. |
|
I created an issue for the extension methods here: #10329. |
It's a PR fixing bug reported in #236