akka/akka-core

Quality assurance of Scaladoc/Javadoc in Typed

Open

#25,598 opened on Sep 12, 2018

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

Repository metrics

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

Description

Go through Scaladoc warnings an verify that it looks good, including javadoc. Add missing pieces.

Contributor guide

Research direction
Review Scaladoc warnings for the Akka Typed module and verify the documentation looks good, including Javadoc. Add any missing documentation pieces.
Tech stack
scala
Domain
backend
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
ScalaAkka
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50