Closed
Description
Most of the guidelines have just two examples chapters. Good and bad. That's ok.
Some guidelines have multiple good/bad chapters (adding all examples under one chapter with comments might be the better option):
- G-3195 (one example set: bad, good, good - no good variant is better than the other, but looks strange)
- G-3120 (two example sets: bad, better, good, bad, good)
- G-4220 (two example set: bad, good, bad good)
Some guidelines use the pattern "Bad - Better - Good":
Some guidelines use the pattern "Bad - Good - Better" (meaning the last option is the best):
Personally I'd like to have a standardized subtitle concept. This would simplify the process of generating the SQL-Script examples for the CLI and the rules representation for PL/SQL Cop in general and SonarQube in particular (the genmodel). But this should not drive the solution. I can always deal with exceptions.
Two things are important IMO:
- Unique subchapters per guideline (different names are OK, multiple examples per chapter are also OK)
- Consistent use "Better". Maybe using "Best" instead of "Better" would make things clearer.
Metadata
Metadata
Assignees
Labels
Something isn't workingSomething isn't working