Clarify that config files require unique keys #7562
Conversation
|
Looks good to me! ⛵ |
| @@ -2,7 +2,8 @@ | |||
| # | |||
| # Atom keymaps work similarly to style sheets. Just as style sheets use | |||
| # selectors to apply styles to elements, Atom keymaps use selectors to associate | |||
| # keystrokes with events in specific contexts. | |||
| # keystrokes with events in specific contexts. (Unlike style sheets however, | |||
| # each selector can only be declared once.) | |||
There was a problem hiding this comment.
I think we can drop the parens here.
Also, it might be helpful to give an example of the error, and then how the error should be corrected (to make things perfectly clear for users who just copy/paste examples). For example:
# This is not correct
#
# 'atom-text-editor':
# 'enter': 'editor:newline'
# 'atom-text-editor':
# 'end': 'editor:move-to-end-of-screen-line'
#
# This is correct:
#
# 'atom-text-editor':
# 'enter': 'editor:newline'
# 'end': 'editor:move-to-end-of-screen-line'
Another approach would be to fix atom/flight-manual.atom.io#43 📝, and then link to those docs with a big WARNING. I think I like that approach a bit more.
There was a problem hiding this comment.
I think I prefer the latter option too – putting the examples inline here would make the comments section really long.
|
⚡ @mnquintana for this -- helping users not make these mistakes would be great. I left two comments -- wondering what your 💭 are. |
|
@izuzak Just opened up atom/flight-manual.atom.io#100 - I'll link to that new section from within these comments. |
| # https://github.com/bevry/cson#what-is-cson | ||
| # If you are unfamiliar with CSON, you can read more about it in the | ||
| # Atom Flight Manual: | ||
| # https://atom.io/docs/latest/using-atom-basic-customization#cson |
There was a problem hiding this comment.
Btw @izuzak, I changed this link to the CSON Primer I added in atom/flight-manual.atom.io#100 – do you think that's okay? There is a footnote in that section to the original link here, and it expands upon the source CSON docs quite a bit.
There was a problem hiding this comment.
Btw @izuzak, I changed this link to the CSON Primer I added in atom/flight-manual.atom.io#100 – do you think that's okay?
Yep, looks great to me 👍
mnquintana
force-pushed
the
mq-dot-atom-cson
branch
from
4f25e0f
to
765e515
Compare
|
😎 Thanks again for this, @mnquintana |
Clarify that config files require unique keys
From #7552 (comment)
A lot of people try to use the config files as they would a stylesheet, trying to override keybindings for instance by repeating the same selector multiple times in the file, which causes issues because CSON keys must be unique. This makes it a bit more explicit that keys need to be unique.