Improve docs for some internal classes related to https://github.com/apache/lucene/issues/15225 #15356
+519
−5
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This PR does not have an entry in lucene/CHANGES.txt. Consider adding one. If the PR doesn't need a changelog entry, then add the skip-changelog label to it and you will stop receiving this reminder on future updates to the PR. |
dweiss
approved these changes
Oct 24, 2025
|
I agree these docs are... verbose. I keep wondering if it makes sense to add llm-generated documentation back to the project - seems like we'd be feeding the snake with its own tail if there's something wrong in there. :) This seems ok though. |
jainankitk
approved these changes
Oct 24, 2025
|
Okay, I was wondering why the github workflow did not automatically add milestone even though CHANGES entry is present. It seems to be added in the 10.3.0 section. @mpbarano - Can you move the CHANGES entry to 10.4.0 section? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This change adds documentation to 4 @lucene.internal classes in the geo package.
This is my first contribution to Lucene. I have read the CONTRIBUTING.md. This change is part of #15225. This change started with Cursor LLM, but I have read everything. I have tried my best to validate that the information is accurate. And I altered the language to remove unnecessary adverbs or other awkward language.
The provided docs are verbose, but they seem useful. I would be happy to have feedback about whether the amount of content is appropriate or whether they should be more terse.