Alan Woodward created LUCENE-10575:
--------------------------------------
Summary: Broken links in some javadocs
Key: LUCENE-10575
URL: https://issues.apache.org/jira/browse/LUCENE-10575
Project: Lucene - Core
Issue Type: Bug
Reporter: Alan Woodward
The release wizard for 9.2 has found some broken javadoc links:
* ExternalRefSorter refers to package-private implementations when it should
probably refer to the relevant interfaces instead
* STMergingTermsEnum refers to package-private classes. I think we can solve
this by making the whole class package-private, given that it's an
implementation detail within a Codec?
* MatchRegionRetriever links to an internal implementation, which should just
be described rather than linked.
These are all fairly simple to fix, and I will open a PR to do so. Slightly
more worrying is that running `./gradlew lucene:documentation:checkBrokenLinks`
does not seem to consistently find these problems. The release wizard runs
against an entirely clean checkout and fails, but attempting to reproduce the
failure on an existing checkout produces a green build. Some of these broken
links have been around for a while - the STMergingTermsEnum ones since 2019 -
so it may just be luck that I found them this time round.
--
This message was sent by Atlassian Jira
(v8.20.7#820007)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org
