Skip to content
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

Typealias extensions are not shown on its page, but the extensions tab is rendered #3229

Open
IgnatBeresnev opened this issue Oct 17, 2023 · 1 comment
Labels
bug feedback: Kotlin libs Feedback from Kotlin's internal libraries
Milestone

Comments

@IgnatBeresnev
Copy link
Member

Context

Typealiases have their own dedicated pages since Dokka 1.9.0 (#2862). It's a relatively new enhancement, so this particular issue likely slipped unnoticed and we didn't think of this use case, but it's not necessarily regression.

Expected

The dedicated page should either contain extension functions for typealiases or it should not, but either way there should be no empty tabs. Either no extension and no tab, or extensions under a tab.

Actual

The Members & Extensions tab is rendered, but there's no content, so the tab is empty.

Screenshot

2023-10-17_21-17-12

Reproducer

Generate documentation for the following code and visit the page for TypeAliasToMyClass.

typealias TypeAliasToMyClass = Unit

fun TypeAliasToMyClass.extension() {}
@IgnatBeresnev
Copy link
Member Author

IgnatBeresnev commented Oct 20, 2023

Update:

  1. Discuss it with Ilya/Seva, see if there are any objections from stdlib; Send a poll to libraries team
  2. It seems we can show extensions only, no members, so the tab should be renamed if possible

Possible confusion points:

  • The users might think that this extension is only available for the typalias, but in reality you can also call it on the aliased class.

@IgnatBeresnev IgnatBeresnev added the feedback: Kotlin libs Feedback from Kotlin's internal libraries label Nov 3, 2023
@IgnatBeresnev IgnatBeresnev added this to the Dokka 2.0.0 milestone Nov 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug feedback: Kotlin libs Feedback from Kotlin's internal libraries
Projects
None yet
Development

No branches or pull requests

1 participant