-
Notifications
You must be signed in to change notification settings - Fork 3.1k
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
Remove incorrect development rule about alphabetizing code #11437
Remove incorrect development rule about alphabetizing code #11437
Conversation
Documentation listings, like list of connectors, should probably be alphabetized, but code sections do not. The logic ordering of components, and grouping of related things, is more important.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should work on this with purpose, not just fire off a PR to remove documentation.
(also, alphabetizing is good for diffs/merges - otherwise everyone attempts to add a line at the "end" of an enum, etc, => Merge confilcts. So it is a good thing in certain cases.)
Also, I'd like this mis-information to be tackled in the same commit:
The code style template for the project can be found in the codestyle repository along with our general programming and Java guidelines.
The code style template for the project can indeed be found in the codestyle repository, https://github.com/airlift/codestyle - however "our general programming and Java guidelines" cannot (unless we mean general programming "code style" guidelines and Java "code style" guidelines).
I'm happy to draft a PR + work with you @findepi (and all other reviewers) to discuss the overall changes before we get into reviews 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should work on this with purpose, not just fire off a PR to remove documentation.
(also, alphabetizing is good for diffs/merges - otherwise everyone attempts to add a line at the "end" of an enum, etc, => Merge confilcts. So it is a good thing in certain cases.)
Also, I'd like this mis-information to be tackled in the same commit:
The code style template for the project can be found in the codestyle repository along with our general programming and Java guidelines.
The code style template for the project can indeed be found in the codestyle repository, https://github.com/airlift/codestyle - however "our general programming and Java guidelines" cannot (unless we mean general programming "code style" guidelines and Java "code style" guidelines).
I'm happy to draft a PR + work with you @findepi (and all other reviewers) to discuss the overall changes before we get into reviews 👍
Aspirationally, that where we intended to capture those guidelines. We never got around to doing that, so that's why it seems like the comment is untrue. The fix would not be to remove the line, but to start capturing those guidelines there. |
i don't see many places where we strive to alphabetize, so it is a non-rule apparently. i see many places where we shouldn't try to alphabetize, because other, more important, logical ordering should be applied. that's why i think the sentence should be removed. |
Documentation listings, like list of connectors, should probably be
alphabetized, but code sections do not. The logic ordering of
components, and grouping of related things, is more important.