scala / scala/scala-java8-compat
Documentation for Future.toJava is stricter than implemented functionality
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 438
- Forks
- 63
- Avg merge
- 5h 12m
- Merged PRs (30d)
- 2
Description
It says here that the CompletionStage returned by FutureConverters doesn't support the toCompletableFuture() interface at all. However, it can be used fine to retrieve the value of a completed future, and/or wait for it. That functionality is currently used by e.g. akka.
The documentation could probably be extended to reflect that waiting / getting is fine, but completing is not.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the documentation at src/main/scala/scala/compat/java8/FutureConverters.scala#L23. Compare its statement about toCompletableFuture() with the reported behavior for retrieving or waiting on a completed future versus completing one. Done means the documentation accurately distinguishes the supported operations from the unsupported one.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100