Skip to content

Commit 5dd1819

Browse files
author
Daniel Gallagher
committed
Warn users of file-contents-sorter that blank lines are removed and comments are not respected
1 parent 7cfec24 commit 5dd1819

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Add this to your `.pre-commit-config.yaml`
5151
with single quoted strings.
5252
- `end-of-file-fixer` - Makes sure files end in a newline and only a newline.
5353
- `fix-encoding-pragma` - Add `# -*- coding: utf-8 -*-` to the top of python files.
54-
- `file-contents-sorter` - Sort the lines in specified files (defaults to alphabetical). You must provide list of target files as input to it.
54+
- `file-contents-sorter` - Sort the lines in specified files (defaults to alphabetical). You must provide list of target files as input to it. Note that this hook WILL remove blank lines and does NOT respect any comments.
5555
- To remove the coding pragma pass `--remove` (useful in a python3-only codebase)
5656
- `flake8` - Run flake8 on your python files.
5757
- `forbid-new-submodules` - Prevent addition of new git submodules.

0 commit comments

Comments
 (0)