apache / apache/lucene

Correct HTML5 linting errors in javadocs [LUCENE-9131]

Open
#10,172 0 comments 0 reactions 0 assignees View on GitHub
legacy-jira-priority:Trivial type:bug
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

This is trivial but pretty involving. Because of a bug in javadoc the linter didn't work properly. I had to disable HTML syntax error linting because there are tons of errors at the moment.

---
Migrated from [LUCENE-9131](https://issues.apache.org/jira/browse/LUCENE-9131) by Dawid Weiss (@dweiss)
Linked issues:
- #10167

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the javadocs and the HTML5 syntax-error linting context described in this issue, then inspect linked issue #10167 for the affected scope. Done means the javadoc HTML errors are corrected and HTML syntax-error linting can be enabled without the reported flood of errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, java
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.