akka/akka-core

Missing docs for Java testkit EventFilter

Open

#26,433 opened on Feb 22, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Scala (3,547 forks)batch import
1 - triagedhelp wantedt:docst:javat:testing

Repository metrics

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

Description

The Java API for EventFilter has one mention in the docs: https://doc.akka.io/docs/akka/current/testing.html#expecting-log-messages

But no Scaladoc/Javadoc explaining how it can take either SomeException.class or a LogEvent subtype to catch specific log entry types.

Add both ref docs and scaladoc.

Contributor guide

Research direction
Examine the existing Java API for EventFilter, review the Scala documentation for LogEvent subtypes, and add reference documentation and Scaladoc/Javadoc for filtering log entries.
Tech stack
scalajava
Domain
documentationtesting
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Akka
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70