Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

format of FILE as in --exclude-file=FILE #2046

Closed
DimitriPapadopoulos opened this issue Aug 22, 2021 · 3 comments · Fixed by #2052
Closed

format of FILE as in --exclude-file=FILE #2046

DimitriPapadopoulos opened this issue Aug 22, 2021 · 3 comments · Fixed by #2052
Labels

Comments

@DimitriPapadopoulos
Copy link
Collaborator

What is the format of FILE as in --exclude-file=FILE?

Is it perhaps of the form "file:line"? If so, I suggest fixing the help message from:

  -x FILE, --exclude-file=FILE
                        FILE with lines that should not be changed

to:

  -x FILE, --exclude-file=FILE
                        FILE with file:line pairs that should not be changed

That would avoid misunderstandings such as #1601 (comment) and codespell-project/actions-codespell#33 (comment).

@DimitriPapadopoulos
Copy link
Collaborator Author

After reading the source code, It appears it's really simple line numbers in the file, not specific to a file. So if you want to exclude line 100 of a specific file, you cannot but exclude line 100 of all files.

@peternewman
Copy link
Collaborator

It's the whole line, not the line number. See #2052 for work to fix this.

@DimitriPapadopoulos
Copy link
Collaborator Author

Ah, I see. Sorry about that. Then let's follow up in #2052.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants