apache/beam

Re-enable checkstyle JavadocParagraph

Open

#18,964 创建于 2022年6月3日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Java (4,097 fork)batch import
P3buildgood first issueimprovement

仓库指标

Star
 (7,313 star)
PR 合并指标
 (平均合并 6天) (30 天内合并 243 个 PR)

描述

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.

贡献者指南

研究方向
在构建配置（例如 pom.xml 或 checkstyle 配置文件）中禁用 checkstyle JavadocParagraph 检查，并可能修复一些 javadoc 问题。
技术栈
java
领域
toolingbuild system
议题类型
维护
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1 小时以内
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
较久未更新
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Java
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85