ruby-style-guide icon indicating copy to clipboard operation
ruby-style-guide copied to clipboard

[Idea] Write "good" before "bad" examples

Open rfc2822 opened this issue 2 years ago • 2 comments

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:

Bildschirmfoto vom 2023-02-16 14-09-11

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

  • write the "Good" examples before the "Bad" examples and
  • maybe disable syntax highlighting for "Bad" examples (or mark them as bad somehow else which is more intuitive than the comment, which may also be above the current view).

I hope my suggestion is placed correctly here.

rfc2822 avatar Feb 16 '23 13:02 rfc2822

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

gagalago avatar Feb 16 '23 15:02 gagalago

There is an attempt at writing such a guide, but it wasn't accepted as one. This comment hints that there was an idea of moving good examples above bad ones.

pirj avatar Feb 16 '23 16:02 pirj