akka/akka-core

Scalafix followups: Move doc specs to doc/jdoc package

Aperta

#26.045 aperta il 5 dic 2018

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

Metriche repository

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

Descrizione

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

Guida contributor

Direzione di ricerca
Identifica le specifiche di documentazione in pacchetti non doc (es. FlowZipSpec in akka.stream.scaladsl) e spostale nel pacchetto doc/jdoc appropriato, assicurandoti che le importazioni dal pacchetto principale siano richieste. Segui lo schema della PR collegata.
Tech stack
scala
Dominio
backend
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitScala
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65