geo.Circle's class javadoc 'Example usage' calls LatLonShape.newDistanceQuery("location", circle), but the only overload is newDistanceQuery(String, QueryRelation, Circle...), so the example has not compiled on any release since #14534 added it in 10.3.0 (documentation defect)

Finding LFV-1019Area: core / geo (Circle class javadoc example)Priority: lowImpact: minorNovelty: new

AI-assisted finding, confirmed by automated checks, not yet triaged by a human Lucene committer. This site files nothing upstream.

What it shows

The javadoc of org.apache.lucene.geo.Circle shows 'Example usage': make a circle of 1 km around the Eiffel Tower, then build a query with LatLonShape.newDistanceQuery("location", circle). Copied into code, that line does not compile on any release that has the example (10.3.0 and later), because the method has always needed a ShapeField.QueryRelation argument that says how indexed shapes must relate to the circle (for example INTERSECTS). With LatLonShape.newDistanceQuery("location", ShapeField.QueryRelation.INTERSECTS, circle) it compiles and matches a point 500 m from the centre but not one 5 km away, so only the javadoc is wrong.

Expected vs actual

Expected: The example compiles, and the query matches 1 of 2 points (500 m in, 5 km out), as the corrected call does on main.
Actual: The compiler, called by the test through javax.tools, reports 1 error at the query line: incompatible types: org.apache.lucene.geo.Circle cannot be converted to org.apache.lucene.document.ShapeField.QueryRelation; the same with assertions off. (Command-line javac prints the same error with short names: incompatible types: Circle cannot be converted to QueryRelation.)

Files

src/org/apache/lucene/geo/TestCircleJavadocExample.java (JUnit test)

Run it

Tested on Lucene main e1faeba08bde (2026-11-02): still reproduces.
Tested on Lucene main 645d4fe14a20 (2026-10-28): reproduced.
How to read the outcome: a failing test is the finding reproducing (the failure message states expected against actual).
Seeds: a rerun with the same seed replays the same random choices. Assertions off (-da -dsa -Dtests.asserts=false) is the production-like setting.

# Lucene checkout at the tested commit, built with: ./gradlew --no-daemon assemble   (JDK 25)
LUCENE=/path/to/lucene; V=12.0.0-SNAPSHOT
CP=$LUCENE/lucene/core/build/libs/lucene-core-$V.jar
CP=$CP:$LUCENE/lucene/codecs/build/libs/lucene-codecs-$V.jar
CP=$CP:$LUCENE/lucene/test-framework/build/libs/lucene-test-framework-$V.jar
CP=$CP:randomizedtesting-runner-2.9.2.jar:junit-4.13.2.jar:hamcrest-3.0.jar   # test-framework dependencies (Maven Central)
CP=$CP:junit-platform-console-standalone-6.1.3.jar   # JUnit Platform console launcher (Maven Central)

javac -d classes -cp "$CP" $(find src -name '*.java')

# run 1: assertions on, seed DEADBEEF
java -ea -esa --add-modules jdk.incubator.vector --enable-native-access=ALL-UNNAMED -Dtests.seed=DEADBEEF \
     -cp "classes:$CP" org.junit.platform.console.ConsoleLauncher \
     execute --select-class org.apache.lucene.geo.TestCircleJavadocExample

Gradle alternative: copy the test into the matching module's src/test/ tree of the checkout and run ./gradlew -p lucene/<module> test --tests <class> -Ptests.seed=<seed> (add -Ptests.asserts=false for a run without assertions).

Files shown on the finding page

TestCircleJavadocExample.java

Feedback

Open an issue in lucene-ai-bug-hunt. Please do not open issues or pull requests in apache/lucene about this finding unless a Lucene committer agrees it should be filed.

Snapshot of 2026-11-04. AI-assisted; not yet triaged by a human Lucene committer. Feedback: open an issue in lucene-ai-bug-hunt.