Clarify check-added-large-files as "kilobytes"

Fix https://github.com/pre-commit/pre-commit-hooks/issues/1170
This commit is contained in:
Christian Heinrich 2025-07-03 06:01:58 +10:00
parent 582b9c66e0
commit 9db0503129
No known key found for this signature in database
GPG key ID: 2B2002437590C7F7

View file

@ -25,7 +25,7 @@ Add this to your `.pre-commit-config.yaml`
#### `check-added-large-files`
Prevent giant files from being committed.
- Specify what is "too large" with `args: ['--maxkb=123']` (default=500kB).
- Specify what is "too large", in kilobytes, with `args: ['--maxkb=123']` (default=500kB).
- Limits checked files to those indicated as staged for addition by git.
- If `git-lfs` is installed, lfs files will be skipped
(requires `git-lfs>=2.2.1`)