apache/beam

Re-enable checkstyle JavadocParagraph

Open

#18,964 opened on Jun 3, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (4,097 forks)batch import
P3buildgood first issueimprovement

Repository metrics

Stars
 (7,313 stars)
PR merge metrics
 (Avg merge 6d) (243 merged PRs in 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.

Contributor guide

Research direction
Disable the checkstyle JavadocParagraph check in the build configuration (e.g., pom.xml or checkstyle configuration file) and possibly fix a few javadoc issues.
Tech stack
java
Domain
toolingbuild system
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Java
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85