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

Mark every rules with levels of requirements.

Open shyouhei opened this issue 10 years ago • 1 comments

Being a non-native English speaker I sometimes have difficulties reading the style guide, especially when it comes to a rule is partially overriding another.

It is clear to me that, say, #parens-as-args is a very strong requirement. It has no conflicting rules. It seems no one shall never ever break this rule.

On the other hand, for instance #ternary-operator has several follow-up rules to describe exceptional situations where this rule should not apply. It seems this rule is not as strong as #parens-as-args.

There also are rules that comes with options; like #consistent-string-literals. It seems the rule is even weaker than #ternary-operator.

I might be wrong. I could have misread something. But the problem is subtleness in the language, which makes it difficult to understand. Being a guide it should be as clear as possible.

I'd like to propose terminology described in RFC2119. They are not only Internet standard, but quite widely used -- which should suit the concept of this style guide.

shyouhei avatar Dec 27 '15 12:12 shyouhei

I love this idea! We should definitely adopt a uniform language in this regard, even if it's exactly what's in RFC2119.

P.S. Sorry the super late response! I haven't been able to catch up with all the tickets here in ages.

bbatsov avatar Jun 12 '19 15:06 bbatsov