Skip to content

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

Open
@rfc2822

Description

@rfc2822

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions