akka/akka-core

Document our Java8 Functional Interface types

Open

#24,145 opened on Dec 12, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Scala (3,547 forks)batch import
1 - triagedhelp wantedt:docs

Repository metrics

Stars
 (13,277 stars)
PR merge metrics
 (Avg merge 8d 19h) (10 merged PRs in 30d)

Description

To make Java interoperability easier we often use the classes in akka.japi.function.

It would be good to document this from the 'user perspective' with some examples of how to pass in standard java8 lambda's that match those types in java8-compat.md, and link to that from the javadoc on those classes.

Contributor guide

Research direction
Identify the akka.japi.function classes and write example usage of Java 8 lambdas for each. Create a new file java8 compat.md with these examples and link it from the javadoc. See existing documentation for format.
Tech stack
javascala
Domain
backenddocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJava
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80