-
-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
[Idea] Write "good" before "bad" examples #915
Comments
I like the idea of having meta style guide (a style guide for the style guide) as we all agree that we should strive for consistency. and I agree that we should more easily see the good example. so maybe, we can highlight these parts https://docs.asciidoctor.org/asciidoc/latest/verbatim/highlight-lines/#rouge |
There is an attempt at writing such a guide, but it wasn't accepted as one. |
I have found the Ruby Style Guide while I was trying to find out which case conventions the Ruby community uses for methods.
Fortunately there's a Ruby Style Guide (thanks!) and I quickly found the Snake Case for Symbols, Methods and Variables section. I didn't know by heart what "snake case" is (I always confuse the case style names and "snake" doesn't say anything to me) so I had a look at the examples.
Here a screenshot how my gaze went:
After 1, 2, 3 was a bit of uncertainness. So after a short pause (color now turquouise instead of red) I discovered 4 (grey and discreet), had to look for 5 and finally found 6, which was the answer for my question.
My suggestions are to
I hope my suggestion is placed correctly here.
The text was updated successfully, but these errors were encountered: