apache/beam

Re-enable checkstyle JavadocParagraph

Ouverte

#18 964 ouverte le 3 juin 2022

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Java (4 097 forks)batch import
P3buildgood first issueimprovement

Métriques du dépôt

Stars
 (7 313 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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.

Guide contributeur

Direction de recherche
Désactivez la vérification JavadocParagraph dans la configuration de build (par exemple, pom.xml ou fichier de configuration checkstyle) et corrigez éventuellement quelques problèmes de javadoc.
Stack technique
java
Domaine
toolingbuild system
Type d'issue
Maintenance
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Java
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85