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

README suggestions #875

Closed
paddymul opened this issue Nov 30, 2023 · 4 comments
Closed

README suggestions #875

paddymul opened this issue Nov 30, 2023 · 4 comments

Comments

@paddymul
Copy link

I was trying to do a PR on a different project, and I had aPR that introduced a reasonable misspelling for a single test file. After reading the README I couldn't figure out how to add an ignore/override for a single file.

I understand that

[type.po]
extend-glob = ["*.po"]
check-file = false

ignores a file

I understand that

[default.extend-identifiers]
# *sigh* this just isn't worth the cost of fixing
AttributeIDSupressMenu = "AttributeIDSupressMenu"

but it's not clear how to add a rule for a single file

I think an example like this would be a very helpful addition to the README

@epage
Copy link
Collaborator

epage commented Nov 30, 2023

Just after the two fragments you mentioned, the README says

If you need some more flexibility, you can completely exclude some files from consideration:

[files]
extend-exclude = ["localized/*.po"]

@epage
Copy link
Collaborator

epage commented Nov 30, 2023

Hmm, if you were wanting to instead extend-identifiers for a single file, we don't support that at the moment (unless you are willing to make its own file type, you can use file names but not file paths).

We do support default.extend-ignore-re which can be used to make emulate inline excludes (#316)

@epage
Copy link
Collaborator

epage commented Dec 13, 2023

As the documentation covers what we have and we have issues for others, I'm going to go ahead and close this. If there is a reason we should reconsider, let us know!

@epage epage closed this as not planned Won't fix, can't repro, duplicate, stale Dec 13, 2023
@paddymul
Copy link
Author

Closing it is fine. Like I said, I encountered this problem when making a first contribution to another project. I'm not an active user of the project. I thought I'd provide the feedback and see if it's helpful.

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

No branches or pull requests

2 participants