checkstyle / checkstyle/checkstyle
Update Documentation Comments Style Guide: add JavadocSeeTagOrder
Open
Beginner friendly
approved
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 4.2k
- Avg merge
- 22h 23m
- Merged PRs (30d)
- 232
Description
After merge of https://github.com/checkstyle/checkstyle/pull/21486, we can update the coverage table for `Ordering Multiple Tags` chapter.
Example of similar update: https://github.com/checkstyle/checkstyle/pull/21357
Contributor guide
Research direction
Start with the coverage table in the Documentation Comments Style Guide under the “Ordering Multiple Tags” chapter, then compare the similar update in pull request 21357. Add the JavadocSeeTagOrder entry enabled by pull request 21486 and verify that the table accurately reflects the new coverage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 78/100