Scaladoc: this.type in type bounds is incorrectly rendered as enclosing class/trait
#17226
Assignees
Labels
Comments
This was referenced Apr 11, 2023
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The following code:
when rendered in Scaladoc results in
Expectation
It should be rendered as:
The text was updated successfully, but these errors were encountered: