paulirwin commented on code in PR #1067: URL: https://github.com/apache/lucenenet/pull/1067#discussion_r1891109211
########## src/Lucene.Net/Util/Packed/README.md: ########## @@ -0,0 +1,28 @@ +# Lucene.Net.Util.Packed + +## Generating the files + +There are four Python scripts in this folder: +[`gen_BulkOperation.py`](gen_BulkOperation.py), +[`gen_Direct.py`](gen_Direct.py), +[`gen_Packed64SingleBlock.py`](gen_Packed64SingleBlock.py), and +[`gen_PackedThreeBlocks.py`](gen_PackedThreeBlocks.py). +These scripts were ported from the original Lucene 4.8.1 code, and modified to generate the corresponding C# code instead of Java. + +To generate the files, run the following commands from this directory: Review Comment: Are you thinking to have the csproj execute the scripts before build? We could certainly do that, although given the low frequency with which these scripts change, and that the generated files are already in the build, I don't know if it's worth the extra effort for users to have to make sure they have Python set up first in order to contribute. This would likely impact Windows users the most, as it's more common for macOS and Linux users (particularly developers) to already have python3 in their PATH. And given that admittedly most .NET developers are using Windows, I worry that it's just a possible speed bump in getting new contributors on board. What we could do is only do this in the build scripts and CI, so that anyone that just opens up the solution in VS/Rider doesn't have to have Python installed to build, but we still get the benefit of being able to test it locally in an automated way as well as have it run as part of the CI builds for regression testing of the scripts. However we do it, note that there is already a PR for the beta18 documentation changes including README changes that could be updated: https://github.com/apache/lucenenet/pull/1043 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: dev-unsubscr...@lucenenet.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
