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

Beautified the .editorconfig file #19873

Merged
merged 1 commit into from Jan 19, 2022
Merged

Conversation

penev92
Copy link
Member

@penev92 penev92 commented Jan 9, 2022

Slight reformatting of the .editorconfig file triggered by #19871 (comment)
I fixed comments, added some hopefully clearer explanations and some fun facts like some things are probably duplicates of StyleCop rules. No functional changes here, just formatting. Changes will come in the next 2 PRs.

Is dependency for #19871.

Pinging @RoosterDragon for this one as well.

RoosterDragon
RoosterDragon previously approved these changes Jan 10, 2022
@penev92
Copy link
Member Author

penev92 commented Jan 16, 2022

Hopefully we cleared the concerns in Discord.

@penev92
Copy link
Member Author

penev92 commented Jan 18, 2022

Alright, since @abcdefg30 didn't post this here I'll guess I'll have to do it for him:
(even if only for documentation purposes)

why aren't you applying our style rules to the style rules file?
comments go on their own line, above the line they comment on
your comments are still at different indentation levels all over the file on the same line as they comment on
with some comments not being on the same line but above

And hence the "Conceptual concerns" label above.

Now, as was explained on Discord, same-line comments are perfectly valid, and in some cases preferable. For some weird reason OpenRA has a rule against those (which I say we remove anyway) in C# code, but it's debatable whether that applies here.
What isn't debatable is that if you do it that way here the .editorconfig becomes utterly unreadable, which kills the entire purpose of this PR (and any potential for further PRs to it). Also "I don't want same-line comments" is a matter of personal taste and shouldn't be cause for a veto.

@abcdefg30
Copy link
Member

Initially I would have let this slip through, but you have made it abundantly clear that you want to use this as precedent for changing the global style rules.

You wrote yourself that same-line comments are a matter of taste. It is not my responsibility to proof that our style rules should not be changed; especially not when even you say it's just about personal taste.

Do whatever you want with the style in the config file; I have no interest in reviewing or discussing it further.

@matjaeck
Copy link

https://editorconfig.org/#file-format-details

Comments should go on their own lines.

🙊

@penev92
Copy link
Member Author

penev92 commented Jan 18, 2022

One could still make a bunch of arguments why that's silly (like this makes it many times less readable and also when have we ever followed standard code style conventions) but at least this is now more than a whim so whatever, I'll change it....

P.S.: Thanks for the link @matjaeck

@abcdefg30 abcdefg30 merged commit 19dd23e into OpenRA:bleed Jan 19, 2022
@penev92 penev92 deleted the editorconfig branch January 19, 2022 20:50
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.

None yet

4 participants