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

API docs omit protected classes such as MapOps#KeySet #18946

Open
som-snytt opened this issue Nov 16, 2023 · 2 comments
Open

API docs omit protected classes such as MapOps#KeySet #18946

som-snytt opened this issue Nov 16, 2023 · 2 comments

Comments

@som-snytt
Copy link
Contributor

Compiler version

Scaladoc version 3.4.0-RC1-bin-SNAPSHOT-git-5454110

Minimized code

I went looking for KeySet.

https://www.scala-lang.org/api/3.3.1/scala/collection/MapOps.html#

Scala 2 doc makes it searchable but also omits it at

https://www.scala-lang.org/api/current/scala/collection/MapOps.html#KeySetextendsAbstractSet[K]withMapOps.this.GenKeySetwithDefaultSerializable

Expectation

Protected classes for implementors are documented.

--help says

                -private  Show all types and members. Unless specified, show only public and protected types and
                          members.

Noticed while probing for undocumented methods.

Relates to scala/bug#11727

@som-snytt som-snytt added itype:bug area:doctool stat:needs triage Every issue needs to have an "area" and "itype" label labels Nov 16, 2023
@WojciechMazur WojciechMazur removed the stat:needs triage Every issue needs to have an "area" and "itype" label label Nov 17, 2023
@WojciechMazur
Copy link
Contributor

@szymon-rd @Florian3k Are you maybe aware why this might happen? Is it maybe just an oversight or an expected behaviour, because e.g. we would not want the users to depend on stdlib internals?

@Florian3k
Copy link
Contributor

It looks like an oversight

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants