apache/beam

Re-enable checkstyle JavadocParagraph

Open

#18.964 aberto em 3 de jun. de 2022

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Java (4.097 forks)batch import
P3buildgood first issueimprovement

Métricas do repositório

Stars
 (7.313 stars)
Métricas de merge de PR
 (Mesclagem média 6d) (243 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Desabilite a verificação de JavadocParagraph do checkstyle na configuração do build (ex.: pom.xml ou arquivo de configuração do checkstyle) e possivelmente corrija alguns problemas de javadoc.
Pilha de tecnologia
java
Domain
toolingbuild system
Tipo Issue
Manutenção
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Java
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85