Javadoc examples should be kept in sync with actual compiled code [LUCENE-8488]
Open
legacy-jira-priority:Minor
type:task
- Dominant language
- Java
- Stars
- 3.6k
- Forks
- 1.4k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 88
Description
This isn't something that is done trivially, unfortunately, but can be hacked around. And it'd help to keep the docs up-to-date.
---
Migrated from [LUCENE-8488](https://issues.apache.org/jira/browse/LUCENE-8488) by Dawid Weiss (@dweiss), updated Dec 18 2019
Linked issues:
- #9527
Contributor guide
Research direction
The issue names Javadoc examples and their relationship to actual compiled code, but provides no file, test, or entry point. Start by locating the relevant Javadoc examples and the compiled examples they describe. Done means establishing a way to keep the documentation synchronized with the compiled code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100