[docs] [ci] automatically re-generate parameter docs via pre-commit #7001
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.
This project uses a script to auto-generate https://lightgbm.readthedocs.io/en/latest/Parameters.html from comments in https://github.com/microsoft/LightGBM/blob/master/include/LightGBM/config.h
To check that that's been done, we have some code that manually checks specific files with
diff
LightGBM/.ci/test.sh
Lines 142 to 147 in 97ff708
This is often missed and has to be taught to new contributors, for example: #6863 (review)
To help simplify CI scripts and hopefully reduce friction for contributors, this proposes automatically re-running that via
pre-commit
.(thanks to my colleague @KyleFromNVIDIA for introducing me to this pattern)
Notes for Reviewers
How I tested this
Changed a comment in
config.h
, ranpre-commit run --all-files
, and sawpre-commit
fail (exit code 1) like this: