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

Add note about --exclude-file in README and update the help text also #2052

Merged
merged 1 commit into from
Jan 3, 2022

Conversation

bwitt
Copy link
Contributor

@bwitt bwitt commented Sep 1, 2021

Add a quick note about using --exclude-file to exclude whole lines, and update the help text too

Copy link
Collaborator

@peternewman peternewman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I prefer your wording, but it would probably make sense if it matched the help file:
https://github.com/codespell-project/codespell/blob/d598d5b/codespell_lib/_codespell.py#L347-L349

Or can you at least add your second sentence to the command help please.

README.rst Outdated Show resolved Hide resolved
@bwitt
Copy link
Contributor Author

bwitt commented Sep 21, 2021

@peternewman I've updated both sets of text to try and bring them closer together; how does that look?

README.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@peternewman peternewman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps also take a look at @kolyshkin work in https://github.com/codespell-project/codespell/pull/2040/files , I suspect their formatting of the METAVAR FILE should make things more readable (in the README file).

@bwitt
Copy link
Contributor Author

bwitt commented Sep 22, 2021

formatted the FILE var in the README; I notice https://github.com/codespell-project/codespell/pull/2040/files also rewords the descriptions in the README a bit (removing The ... flag can be used ...). Should we do the same here?

@peternewman
Copy link
Collaborator

I notice https://github.com/codespell-project/codespell/pull/2040/files also rewords the descriptions in the README a bit (removing The ... flag can be used ...). Should we do the same here?

I suspect fewer words makes it easier to read, so that's probably a good idea.

codespell_lib/_codespell.py Outdated Show resolved Hide resolved
@kolyshkin
Copy link

Can I suggest something like

    codespell -x FILE, --exclude-file=FILE
Ignore the whole lines that match those taken from ``FILE``.

@bwitt
Copy link
Contributor Author

bwitt commented Sep 23, 2021

thanks! I've updated it; how does that look?

@kolyshkin
Copy link

@bwitt can you please squash your commits?

@bwitt bwitt changed the title Add note about --exclude-file in README Add note about --exclude-file in README and update the help text also Sep 23, 2021
@bwitt
Copy link
Contributor Author

bwitt commented Sep 23, 2021

squashed

README.rst Outdated Show resolved Hide resolved
@bwitt
Copy link
Contributor Author

bwitt commented Oct 20, 2021

@peternewman how does this look?

Copy link
Collaborator

@peternewman peternewman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one minor tweak from me.

codespell_lib/_codespell.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@peternewman peternewman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

I'll just give other people a chance to take a look before merging.

@peternewman
Copy link
Collaborator

@kolyshkin @DimitriPapadopoulos do you want to take another look?

@DimitriPapadopoulos
Copy link
Collaborator

It looks good to me. It is now much harder to misunderstand as line numbers.

@bwitt
Copy link
Contributor Author

bwitt commented Jan 3, 2022

@peternewman rebased and squashed to one commit; please let me know if there's anything else I need to do.

Copy link

@kolyshkin kolyshkin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@peternewman peternewman merged commit 618dda3 into codespell-project:master Jan 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

format of FILE as in --exclude-file=FILE
4 participants