Fixes #(959): Fix TermStats.TermText access, add CLI comments and 1 CLI bug fix
- [ ] You've read the Contributor Guide and Code of Conduct.
- [ ] You've included unit or integration tests for your change, where applicable.
- [ ] You've included inline docs for your change, where applicable.
- [X] There's an open issue for the PR that you are making. If you'd like to propose a change, please open an issue to discuss the change or find an existing issue.
Summary of the changes (Less than 80 chars)
Fixes #959: Fix TermStats.TermText access, add CLI comments and 1 CLI bug fix
Description
- Converts TermStats.TermText into a public property and changes it's case to follow .NET conventions.
- Code sweep of all the Main(args) methods that relate to the lucene-cli so they now have XML summary comments that indicate that they are not intended for direct use but rather are used by the lucene-cli. If the Main method is in a static class that looks to be designed solely for use from the command line then similar comments are added to the class.
- In the process of doing the code sweep to add comments, I discovered one cli command Lucene,Net.Cli.BenchmarkFindQualityQueriesCommand that was wired up to the wrong command class. So I fixed this bug as well by wiring it up the right one which is QualityQueriesFinder.Main(args).
- the 4th commit was due to realizing that I had one failing test due to me making TermStats.TermText a public field rather than a public property. So this commit fixes that and the failing unit test.
Hi Shad, I appreciate the time you've taken to review the PR, but I have to admit that some of the feedback feels a bit discouraging. The comments in this contribution aim to significantly improve the documentation for these methods. While it's true that many of these static main(args) methods could technically be called by application code, they were designed with command-line usage in mind. I believe these comments provide valuable context for developers who might find such methods unusual in a .NET DLL. By pointing them to the Lucene CLI and even specifying the relevant commands, these comments help to clarify an otherwise puzzling aspect of the project.
In my view, the PR as it stands makes a positive contribution and moves the project forward. Rather than focusing on further refinement of the comments, I would suggest that the primary question should be whether this contribution, overall, improves the project. If it does, I believe it warrants approval.
Thanks again for your consideration!
Shoot, I did a bad merge. Going to force push to revert that
Addressed the following:
- Reverted demo comment changes (apart from a few param docs that I left)
- Changed to use
<para /> - Made the verbiage changes to remove the warning not to use directly
- Made the verbiage/link changes to specify that lucene-cli is a .NET tool
Item 1 above and improving the documentation of the commands further can be a separate, future enhancement.