Change .editorconfig to use indent = 8 for Makefiles#1038
Change .editorconfig to use indent = 8 for Makefiles#1038mhucka wants to merge 4 commits intoquantumlib:mainfrom
.editorconfig to use indent = 8 for Makefiles#1038Conversation
61c743b to
48a537c
Compare
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request modifies the .editorconfig file by removing the indent_size = 4 specification for Makefiles. Feedback suggests explicitly setting the indentation size to 8 to ensure consistency across different editors and to align with the stated intent of the pull request.
Although tabs usually default to 8 columns, people who set their editors to a different value for the tab width may see different indentation in project files unless we explicitly specify a tab width of 8 in `.editorconfig`.
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request modifies the .editorconfig file by reordering properties and adjusting indentation settings. The review feedback suggests that the global tab_width setting may cause inconsistent indentation for unspecified file types and recommends explicitly setting indent_size for Makefiles to maintain project consistency and readability.
.editorconfig
Outdated
| insert_final_newline = true | ||
| max_line_length = 80 | ||
| spelling_language = en-US | ||
| tab_width = 8 |
There was a problem hiding this comment.
Adding tab_width = 8 to the global [*] section can lead to inconsistent indentation across the project. In many editors, tab_width is used as a fallback for indent_size when the latter is not specified, even for indent_style = space. This would cause any file types not explicitly defined in this file to default to an 8-space indentation, which is inconsistent with the 2 or 4 spaces used throughout the rest of the project. To maintain Consistency (Repository Style Guide, line 14), it is better to specify the indentation width only within the relevant file-type blocks.
References
- Consistency: Be consistent with naming convention, style, and other patterns in the code base. (link)
|
/gemini review |
| charset = utf-8 | ||
| indent_style = space | ||
| insert_final_newline = true | ||
| max_line_length = 80 |
There was a problem hiding this comment.
The pull request description states that an explicit global default for tab_width = 8 is being set, but this setting is missing from the [*] section. This should be added to ensure consistent tab rendering across all file types as intended.
max_line_length = 80
tab_width = 8
References
- Consistency: Be consistent with naming convention, style, and other patterns in the code base. (link)
This undoes a previous change that set the indent size to 4 in
.editorconfig. Per discussion with other people, setting it to 4 makes editing Makefiles more error-prone.In addition, this sets
tab_width = 8for Makefiles. This is to avoid leaving the tab width to whatever the user's default may be, so that they get the value expected in this project.