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

Lack of documentation for most methods #92

Open
smarter opened this issue Mar 4, 2020 · 4 comments
Open

Lack of documentation for most methods #92

smarter opened this issue Mar 4, 2020 · 4 comments

Comments

@smarter
Copy link
Member

smarter commented Mar 4, 2020

Because the parallel collections no longer inherit from the regular collections, they don't inherit any documentation from them, which means that most methods (map, groupBy, ...) have zero documentation in the generated scaladoc (e.g.: https://www.javadoc.io/static/org.scala-lang.modules/scala-parallel-collections_2.13/0.2.0/scala/collection/parallel/ParSeq.html#groupBy[K](f:T=%3EK):scala.collection.parallel.immutable.ParMap[K,Repr]).

@NthPortal
Copy link
Contributor

in principle, it shouldn't be too hard to copy-paste the text from scala/scala

@NthPortal
Copy link
Contributor

I'm a bit concerned by how long this has gone unaddressed. it seems to be both high value/importance and low effort/cost, at least on the surface. of course, I say this while myself not doing anything about it. I don't know whether the module is officially maintained by Lightbend or the Scala Center, but it seems to me like it ought to be a priority for the maintaining team to allocate just a couple of hours for someone to work on this

@smarter
Copy link
Member Author

smarter commented Nov 19, 2021

I don't know whether the module is officially maintained by Lightbend or the Scala Center

The README says:

This module is community-maintained, under the guidance of the Scala team at Lightbend.

@NthPortal
Copy link
Contributor

oops. I forgot about the existence of READMEs.

well, I'm community, so if it's community-maintained, perhaps I should take care of it. I'll see if I can get to it soon-ish

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