Add a few more notes to the style guide#13055
Conversation
docs/markdown/Style-guide.md
Outdated
| ## Tabs or spaces? | ||
|
|
||
| Always spaces. | ||
| Always spaces. Two spaces is most common. |
There was a problem hiding this comment.
Is it really?
I religiously avoid them, personally.
There was a problem hiding this comment.
I don't know! :) I thought it was 2; I just looked in the test suite and saw mostly 2 spaces; but I don't have a good sense of what people do in the wild.
There was a problem hiding this comment.
Anecdotally, muon fmt which is supported by the vscode extension, defaults to 4 spaces but allows you to configure an arbitrary "indentation string".
There was a problem hiding this comment.
Most of our documentation uses two space indent, and that's what I use, so anything I've worked on has two space indent. I picked that style up from what @jpakkane was doing.
docs/markdown/Style-guide.md
Outdated
|
|
||
| ## Trailing commas? | ||
|
|
||
| Yes where possible. They help make nicer diffs in version control systems. |
There was a problem hiding this comment.
+1, the "JSON Problem" should be avoided wherever possible.
s/ideomatic/idiomatic/ in the commit message. |
Ericson2314
force-pushed
the
style-notes
branch
from
b53025b to
52a5a50
Compare
|
Fixed the commit message and removed the |
- Mention 2 space indent seems to be the most idiomatic - Mention trailing commas are good - Update example to use trailing commas
Ericson2314
force-pushed
the
style-notes
branch
from
52a5a50 to
b73c501
Compare
|
Thanks! |
6 participants
Mention 2 space indent seems to be the most ideomatic
Mention trailing commas are good
Update example to use trailing commas