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

Odd grammatical syntax at supported-properties/root #30

Open
Atlas48 opened this issue Mar 12, 2022 · 1 comment
Open

Odd grammatical syntax at supported-properties/root #30

Atlas48 opened this issue Mar 12, 2022 · 1 comment
Labels
clarification Improve text without changing its meaning

Comments

@Atlas48
Copy link

Atlas48 commented Mar 12, 2022

The text at the aforementioned point reads:

root: special property that should be specified at the top of the file outside of any sections. Set to "true" to stop .editorconfig files search on current file.

As a L1 english speaker, I cannot read the above point, "to stop .editorconfig files search" lacks a definite article, perhaps the author meant ""to stop the .editorconfig files searching the current file"? What is exactly meant by "current file"?

I'm happy to file a pull request, I just lack the context of what it's referring to, hence why I filed an issue first.

@cxw42
Copy link
Member

cxw42 commented Mar 12, 2022

Thanks for pointing this out! The full details are in https://editorconfig-specification.readthedocs.io/#file-processing. What about something like this?---

 Must be specified in the preamble.  Set to true to 
-stop the `.editorconfig` file search on
+tell the core not to check any higher directory for EditorConfig settings for
 the current file.  The value is case insensitive.
+([details](https://editorconfig-specification.readthedocs.io/#file-processing))

@cxw42 cxw42 transferred this issue from editorconfig/editorconfig.github.com Mar 12, 2022
@cxw42 cxw42 added the clarification Improve text without changing its meaning label Mar 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clarification Improve text without changing its meaning
Projects
None yet
Development

No branches or pull requests

2 participants