Skip to content

Prefix in path dependent type lost in scaladoc #16143

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

Closed
prolativ opened this issue Oct 5, 2022 · 0 comments · Fixed by #17213
Closed

Prefix in path dependent type lost in scaladoc #16143

prolativ opened this issue Oct 5, 2022 · 0 comments · Fixed by #17213
Assignees
Milestone

Comments

@prolativ
Copy link
Contributor

prolativ commented Oct 5, 2022

Compiler version

3.2.2-RC1-bin-20221003-5d1497d-NIGHTLY

Minimized code

trait Foo[A]:
  type Out

trait Bar[A]:
  type Out

def foo[A](using f: Foo[A])(using b: Bar[f.Out]): b.Out = ???

Output

foo is shown in the docs as

def foo[A](using f: Foo[A])(using b: Bar[Out]): Out

Expectation

The path prefixes should not be lost from the result type, so Out should be f.Out or b.Out, as defined in the source code. The prefixes should be always preserved - even if there's no ambiguity within a signature.

Florian3k added a commit that referenced this issue Jun 2, 2023
This PR introduces multiple fixes and improvements to type rendering in
Scaladoc

- Fixed rendering of TypeRefs (`A#B`) and TermRefs (`a.b.type`)
- Fixed rendering of `Tuple1[T]` (previously `(T)`)
- Fixed rendering of `this.type` (except for type bounds, see below)
- Types with `@showAsInfix` are rendered infix
- Correct parenthesizing around infix types, `&` types, `|` types and
function types
- Type parameters of superclasses in inherited methods are substituted
with actual types from inheriting class/trait (see
`scaladoc-testcases/src/tests/supertypeParamsSubstitution.scala`)

https://github.com/lampepfl/dotty/pull/17213/files#diff-93a78912075a9fdb34fefa437d191be59888cb723ccb244374e77033d9eca779R12-R20
- `this` and `type` are highlighted as keywords

fixes #16024
fixes #16143
fixed #16057
fixes #16084 (partially) - fixed rendering of `Int` instead of `n.type`
and `(This, n.type)` instead of `Split[This, n.type]`. `this.type` in
type bounds remains unfixed. I created separate issue for that #17226

Documentation with those changes has been deployed to
https://scala3doc.virtuslab.com/pr-types-rendering-fixes/scala3/api/index.html
@Kordyjan Kordyjan added this to the 3.4.0 milestone Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants