akka/akka-core

Improve Scheduler docs a bit

Open

#22,575 opened on Mar 16, 2017

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

Description

We should be more helpful in the docs comment as Endre pointed out here: https://github.com/akka/akka/pull/22334#discussion_r102905729

Contributor guide

Tech stack
scala
Domain
documentation
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
The issue points to a specific discussion in PR #22334 about improving the scheduler docs comment. The contributor should locate the Scheduler docs in the codebase (likely in akka actor/src/main/scala/akka/actor/Scheduler.scala or similar) and make the doc comment more helpful as suggested in the linked conversation.
Improve Scheduler docs a bit · akka/akka-core#22575 | Good First Issue