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 for scala.concurrent incomplete #6099

Closed
scabug opened this issue Jul 17, 2012 · 5 comments
Closed

Scaladoc for scala.concurrent incomplete #6099

scabug opened this issue Jul 17, 2012 · 5 comments

Comments

@scabug
Copy link

@scabug scabug commented Jul 17, 2012

The Scaladoc comments for some types and members are either missing, incomplete, or of low quality. Types: scala.concurrent.Awaitable, scala.concurrent.ExecutionContext

The doc comment of Future.firstCompletedOf, for example, should be improved.

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented Jul 17, 2012

Imported From: https://issues.scala-lang.org/browse/SI-6099?orig=1
Reporter: @phaller
Affected Versions: 2.10.0
Other Milestones: 2.10.0

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented Sep 26, 2012

@heathermiller said (edited on Sep 26, 2012 11:06:17 AM UTC):
Elevating this, as it's a critical scaladoc/API documentation bug that needs to be resolved before the RC.

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented Sep 26, 2012

@heathermiller said:
Philipp- there's also a way in Scaladoc to prevent entire packages from being documented. For the sake of simplicity, I'd argue that the scala.concurrent.impl package ought not to be documented. While you're cleaning up the scala.concurrent API docs, could you also go ahead and prevent the impl package from being documented?

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented Oct 10, 2012

@phaller said:
I just submitted a pull request which fixes several issues:
scala/scala#1485

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented Oct 10, 2012

@heathermiller said:
Updated pull at, scala/scala#1486

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

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.