apache/beam

Re-enable checkstyle JavadocParagraph

Aperta

#18.964 aperta il 3 giu 2022

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)Java (4097 fork)batch import
P3buildgood first issueimprovement

Metriche repository

Star
 (7313 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

When spotless reformats javadoc, many of our javadoc comments are revealed to be broken, missing paragraph tags. Rather than force them all to be fixed in a single PR, we could disable the check and do it a few at a time, since it is easy "idle hands" work. This JIRA tracks that (the actual disabling is not yet committed).

Imported from Jira BEAM-4670. Original Jira may contain additional context. Reported by: kenn.

Guida contributor

Direzione di ricerca
Disabilita il controllo checkstyle JavadocParagraph nella configurazione di build (ad esempio pom.xml o file di configurazione checkstyle) e possibilmente correggi alcuni problemi di javadoc.
Tech stack
java
Dominio
toolingbuild system
Tipo issue
Manutenzione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Java
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85