akka/akka-core

Missing docs for Java testkit EventFilter

オープン

#26,433 opened on 2019/02/22

GitHub で見るコントリビューターガイド
 (0 件のコメント) (0 件のリアクション) (0 人の担当者)Scala (3,547 件のフォーク)batch import
1 - triagedhelp wantedt:docst:javat:testing

Repository metrics

Stars
 (13,277 個のスター)
PR merge metrics
 (平均マージ 8d 19h) (30d で 10 merged PRs)

説明

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.

コントリビューターガイド

調査方針
既存のEventFilterのJava APIを調べ、ScalaのドキュメントのLogEventサブタイプを確認し、ログエントリをフィルタリングするための参照ドキュメントとScaladoc/Javadocを追加します。
技術スタック
scalajava
領域
documentationtesting
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1時間未満
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Akka
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70