akka/akka-core

Missing docs for Java testkit EventFilter

Aperta

#26.433 aperta il 22 feb 2019

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)Scala (3547 fork)batch import
1 - triagedhelp wantedt:docst:javat:testing

Metriche repository

Star
 (13.277 stelle)
Metriche merge PR
 (Merge medio 8g 19h) (10 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina l'API Java esistente per EventFilter, rivedi la documentazione Scala per i sottotipi di LogEvent e aggiungi documentazione di riferimento e Scaladoc/Javadoc per filtrare le voci di log.
Tech stack
scalajava
Dominio
documentationtesting
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Akka
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70