Improve docs for some internal classes related to https://github.com/apache/lucene/issues/15225 #15356
Conversation
| 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. |
| 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 left a comment
jainankitk left a comment There was a problem hiding this comment.
Looks fine to me. Although, I am wondering if we really need verbose documentation for classes annotated @lucene.internal. But, I guess it shouldn't hurt!
| 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? |
| This PR has not had activity in the past 2 weeks, labeling it as stale. If the PR is waiting for review, notify the dev@lucene.apache.org list. Thank you for your contribution! |
| I am not gonna block this, but this list of "key features", and the repeating of concepts over and over again (e.g. Haversin Distance) smell of LLMs. LLMs continually over-repeat things because it's cheap for them. It's not for humans. Also, the |
4 participants
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.