Skip to content

Scaladoc: add extension suffixes and fqName to scaladoc searchbar #15048

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 1 commit into from
May 4, 2022

Conversation

jchyb
Copy link
Contributor

@jchyb jchyb commented Apr 27, 2022

Suffixes in the form of italic extension on (...) for extension defs will allow to separate semantically different methods, which previously would have been displayed as the same in searchbar.
File-based location was also replaced with fully qualified name based, in an effort to improve overall readability.
Fixes #14486

Can be viewed on: https://scala3doc.virtuslab.com/pr-fix-searchbar-repeating/scala3/index.html

Zrzut ekranu 2022-04-27 o 11 59 36

@jchyb jchyb requested a review from pikinier20 April 27, 2022 13:02
Copy link
Contributor

@pikinier20 pikinier20 left a comment

Choose a reason for hiding this comment

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

Overally, it looks very good to me

div(cls := "scaladoc-searchbar-row monospace", "result" := "")(
a(href := location)(
p.fullName,
span(cls := "italic")(extensionTargetMessage),
Copy link
Contributor

Choose a reason for hiding this comment

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

Could be just:

span(i(extensionTargetMessage))

Then, you wouldn't need to add CSS rule to make the text italic.

Extension suffixes in the form of italized 'extension on (...)' allow to
separate semantically different methods, which previously would have
been displayed as the same in searchbar.
File-based location was also replaced with fully qualified name based,
in an effort to improve readability.
@jchyb jchyb force-pushed the scaladoc/fix-searchbar-repeating branch from c79f586 to 9e1f5a9 Compare April 28, 2022 10:10
@pikinier20 pikinier20 merged commit 646f1a5 into scala:main May 4, 2022
@Kordyjan Kordyjan added this to the 3.2.0 milestone Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Scaladoc: multiple entries in searchbar for the same function
3 participants