akka/akka-core

Scalafix followups: Move doc specs to doc/jdoc package

Open

#26,045 opened on Dec 5, 2018

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

Repository metrics

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

Description

https://github.com/akka/akka/pull/26019#pullrequestreview-181636601 introduced scalafix to remove unused imports. It is not enabled on compile and can remove imports that are included in specs for docs.

To followup:

  • Ignore files in doc/jdoc package
  • Move any doc specs to the doc for Scala and jdoc package so that imports are necessary e.g. FlowZipSpec is in the akka.stream.scaladsl and is used for docs. The unit test parts should remain but the docs part should be in a new file in the docs package do that imports from akka.stream.scaladsl are required
  • Test how fast it is to enable on compile and decide if we want it enabled by default

Contributor guide

Research direction
Identify doc specs in non doc packages (e.g., FlowZipSpec in akka.stream.scaladsl) and move them to the appropriate doc/jdoc package, ensuring imports from the main package are required. Follow the pattern from the linked PR.
Tech stack
scala
Domain
backend
Issue type
Refactor
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
GitScala
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65