-
Notifications
You must be signed in to change notification settings - Fork 4
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
Update README.md for snippet installation #26
Conversation
Help for newcomers on how to enable SiB snippets in Atom editor
Hey @JoshCheek Hmm. Just to be clear... I did see you mention the snippets in current README But...
So my PR changes were geared around installing the snippets to get them to work. Does that make sense? Did your snippets automatically work for you after installing |
Ohhh...are you trying to show in the gif that AFTER you set the file type to That is something I did not try out. And you may be right. I just know the snippets didn't expand for me and so I brute forced it by manually copy / pasting in as new snippet. Let me check.... |
Hmm, it's strange, I haven't experienced this issue before. The most likely thing I can think of is that the language wasn't set to Ruby, so it didn't match the snippets' scope. I'll see if I can find someone willing to try reproducing the issue. |
Nope - you're right @JoshCheek
So maybe I'll just change PR to emphasize ensuring file type is set to |
Changed to make sure people know to have new/blank files set as `Ruby` This allows Atom to recognize the snippets and expand them
I updated README with results of our conversation above. |
Lets just remove the Ruby scope. It clearly trips people up, I've hit it before, too, if we scope it at something higher, then it removes that hurdle. I don't think we need to worry about collision due to their names being pretty unique. I'd also prefer to avoid encouraging users to save the file, I almost never have that use case, so it seems like it would be polluting their file system just to set the language (note that you can set the scope with Would you be willing to do that? I don't know what the scope should be, I'd prob figure it out by looking for a snippet that is language agnostic and seeing what they used there, if I couldn't find one, probably just try |
These two might have info on a better selector: |
Ah I gotcha. Honestly - that stuff is above my level. I understand conceptually what you are saying, but you would be a much better judge. My take - asking people to set file extension to Feel free to toss this PR, and thanks again for making this! Spreading the word to my co-workers. |
I can do it if you like, just didn't want to take the opportunity from you :) It should be a change to this line, which is scoping the snippets so that they are only available inside of ruby code. If we change it to something else, like |
I went ahead and updated the scope. Thanks for bringing this to my attention, I've had a number of UX issues over the years, but I do think it is incredibly important, so it's good that we're finding and fixing things like this ^_^ |
Ah sorry @JoshCheek - got caught up in work yesterday :) Yes - your change makes more sense when you pointed the line out. That should work well. Thanks for the help! |
Help for newcomers on how to enable SiB snippets in Atom editor
This wasn't immediately obvious to me after watching the video and reading the docs.
Great work!