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

Scaladoc: fix #14481: certain functions not being shown in searchbar #14546

Merged

Conversation

jchyb
Copy link
Contributor

@jchyb jchyb commented Feb 23, 2022

Allows to search for public members inherited from hidden classlikes in Scaladoc. Additionally, to avoid confusing users about the missing link in the "Inherited from:" field, a (hidden) adnotation was also added to the superclass name of those function members.

Fixes #14481

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.

Could you provide an example member that is added by this PR?
Also, it might be worth adding a signature test for this.

Allows to search for public members inherited from hidden classlikes
in Scaladoc. Additionally, to avoid confusing users about the missing
link in the "Inherited from:" field, a "(hidden)" adnotation was also
added. A "inheritedMembersFromHidden" Signature Test was also added.
@jchyb jchyb force-pushed the scaladoc/searchbar-inherited-hidden branch from 78bd5a9 to 598b8d3 Compare February 28, 2022 08:57
@jchyb jchyb changed the title Scaladoc: fix #14481: certain functions not being shown in Scaladoc Scaladoc: fix #14481: certain functions not being shown in searchbar Feb 28, 2022
@jchyb
Copy link
Contributor Author

jchyb commented Feb 28, 2022

@pikinier20 I've noticed now that I've misnamed this PR before - the methods were only missing from searchbar. Nevertheless I've added a SignatureTest for an example use case this issue presents. As for the searchbar itself, any StdIn method (e.g. readBoolean) would not show up there before. This is because they are being inherited from package private trait, rendering it inaccessible in API.

@TheElectronWill TheElectronWill merged commit f4a8983 into scala:main Mar 17, 2022
@Kordyjan Kordyjan added this to the 3.1.3 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 this pull request may close these issues.

Scaladoc: can't find some functions using searchbar
6 participants