Skip to content

Conversation

@mipo256
Copy link
Member

@mipo256 mipo256 commented May 11, 2025

Closes #86

CC: @xuhdev


📚 Documentation preview 📚: https://editorconfig-specification--87.org.readthedocs.build/

@mipo256 mipo256 requested a review from xuhdev May 11, 2025 13:42
@mipo256 mipo256 added enhancement New feature or request clarification Improve text without changing its meaning labels May 11, 2025
index.rst Outdated
Non-existing directories are treated as if they exist and are empty. All found
EditorConfig files are searched for sections with section names matching the
given filename. The search shall stop if an EditorConfig file is found with
EditorConfig files are searched for sections with section glob expressions matching
Copy link
Member

Choose a reason for hiding this comment

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

This is a different topic than "empty editorconfig files." Would you please move it to a separate PR? That would make the git history cleaner, and this PR more focused. Thanks!

Copy link
Member Author

Choose a reason for hiding this comment

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

Fully agree. I can move it into a separate "polishing" commit. What are you thoughts on this, @cxw42 ?

CC: @xuhdev

Copy link
Member

Choose a reason for hiding this comment

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

Actually, now that I think about it more, I believe this should stay as it was. "Section name" is defined above (here). Using the term in this paragraph is therefore unambiguous.

Consider the section name [{*.txt,*.md}]. At the command prompt, I would think of that as two "glob expression"s (*.txt and *.md). However, in this paragraph the whole name {...} is taken as a unit. I worry that if we made this change it might confuse readers. Sorry for the late change!

@mipo256 mipo256 requested review from cxw42 and xuhdev May 12, 2025 15:57
cxw42

This comment was marked as outdated.

@cxw42
Copy link
Member

cxw42 commented May 14, 2025

@mipo256 Apologies for the confusion --- I hit Submit too soon. Please see #87 (comment) . I thought about it some more and realized I think "section name" should stay as it is --- details in that comment. Thanks!

@mipo256
Copy link
Member Author

mipo256 commented May 14, 2025

I agree with you, @cxw42. I think it makes sense to retain the "section name" change to retain as it is.

However, the section name, as I see it, is a single glob expression, that contains the multiple parts, like the following: [a-zA-Z0-9]{4} - it is a single regexp, that contains a character group and a quantifier. So I think:

At the command prompt, I would think of that as two "glob expression"s (*.txt and *.md)

It is not fully accurate, these are parts of a single glob (I might be wrong, but this is as far as I see it).

But at the end of the day, I see your suggestion as a good way to go. I rolled back the change.

@mipo256 mipo256 requested a review from cxw42 May 14, 2025 08:35
@mipo256
Copy link
Member Author

mipo256 commented May 14, 2025

FTR: I'll squash the commits before merge, do not worry.

CC: @cxw42 @xuhdev

@cxw42
Copy link
Member

cxw42 commented May 15, 2025

@mipo256 thanks! Yes, I agree the phrase "glob expression" could be interpreted multiple ways.

@cxw42 cxw42 merged commit 8300175 into master May 15, 2025
1 check passed
@cxw42 cxw42 deleted the empty-editorconfig-files branch May 15, 2025 23:25
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 enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Empty EditorConfig files clarification

4 participants