From 068733a9d357c4a760195facd44ed6d1b2d250ee Mon Sep 17 00:00:00 2001 From: Vitalii Elenhaupt Date: Mon, 3 Sep 2018 22:53:11 +0300 Subject: [PATCH] Correct yaml configuration examples in docs --- src/ameba/rule/layout/line_length.cr | 2 +- src/ameba/rule/layout/trailing_blank_lines.cr | 2 +- src/ameba/rule/layout/trailing_whitespace.cr | 2 +- src/ameba/rule/lint/comparison_to_boolean.cr | 2 +- src/ameba/rule/lint/debugger_statement.cr | 2 +- src/ameba/rule/lint/empty_ensure.cr | 7 +++++++ src/ameba/rule/lint/empty_expression.cr | 2 +- src/ameba/rule/lint/hash_duplicated_key.cr | 2 +- src/ameba/rule/lint/literal_in_condition.cr | 2 +- src/ameba/rule/lint/literal_in_interpolation.cr | 2 +- src/ameba/rule/lint/percent_array.cr | 2 +- src/ameba/rule/lint/rand_zero.cr | 2 +- src/ameba/rule/lint/shadowed_argument.cr | 2 +- src/ameba/rule/lint/shadowed_exception.cr | 2 +- src/ameba/rule/lint/shadowing_local_outer_var.cr | 2 +- src/ameba/rule/lint/unused_argument.cr | 2 +- src/ameba/rule/lint/useless_assign.cr | 2 +- src/ameba/rule/lint/useless_condition_in_when.cr | 2 +- src/ameba/rule/style/constant_names.cr | 2 +- src/ameba/rule/style/large_numbers.cr | 2 +- src/ameba/rule/style/method_names.cr | 2 +- src/ameba/rule/style/negated_conditions_in_unless.cr | 2 +- src/ameba/rule/style/predicate_name.cr | 2 +- src/ameba/rule/style/redundant_begin.cr | 2 +- src/ameba/rule/style/type_names.cr | 2 +- src/ameba/rule/style/unless_else.cr | 2 +- src/ameba/rule/style/variable_names.cr | 2 +- src/ameba/rule/style/while_true.cr | 2 +- 28 files changed, 34 insertions(+), 27 deletions(-) diff --git a/src/ameba/rule/layout/line_length.cr b/src/ameba/rule/layout/line_length.cr index f53c453d..c69968e6 100644 --- a/src/ameba/rule/layout/line_length.cr +++ b/src/ameba/rule/layout/line_length.cr @@ -4,7 +4,7 @@ module Ameba::Rule::Layout # YAML configuration example: # # ``` - # LineLength: + # Layout/LineLength: # Enabled: true # MaxLength: 100 # ``` diff --git a/src/ameba/rule/layout/trailing_blank_lines.cr b/src/ameba/rule/layout/trailing_blank_lines.cr index fdf4932f..321d8aaa 100644 --- a/src/ameba/rule/layout/trailing_blank_lines.cr +++ b/src/ameba/rule/layout/trailing_blank_lines.cr @@ -4,7 +4,7 @@ module Ameba::Rule::Layout # YAML configuration example: # # ``` - # TrailingBlankLines: + # Layout/TrailingBlankLines: # Enabled: true # ``` # diff --git a/src/ameba/rule/layout/trailing_whitespace.cr b/src/ameba/rule/layout/trailing_whitespace.cr index d387a5cf..a4df797e 100644 --- a/src/ameba/rule/layout/trailing_whitespace.cr +++ b/src/ameba/rule/layout/trailing_whitespace.cr @@ -4,7 +4,7 @@ module Ameba::Rule::Layout # YAML configuration example: # # ``` - # TrailingWhitespace: + # Layout/TrailingWhitespace: # Enabled: true # ``` # diff --git a/src/ameba/rule/lint/comparison_to_boolean.cr b/src/ameba/rule/lint/comparison_to_boolean.cr index e3dc0445..3e595b51 100644 --- a/src/ameba/rule/lint/comparison_to_boolean.cr +++ b/src/ameba/rule/lint/comparison_to_boolean.cr @@ -16,7 +16,7 @@ module Ameba::Rule::Lint # YAML configuration example: # # ``` - # ComparisonToBoolean: + # Lint/ComparisonToBoolean: # Enabled: true # ``` # diff --git a/src/ameba/rule/lint/debugger_statement.cr b/src/ameba/rule/lint/debugger_statement.cr index a0cfad1c..40c66139 100644 --- a/src/ameba/rule/lint/debugger_statement.cr +++ b/src/ameba/rule/lint/debugger_statement.cr @@ -7,7 +7,7 @@ module Ameba::Rule::Lint # YAML configuration example: # # ``` - # DebuggerStatement: + # Lint/DebuggerStatement: # Enabled: true # ``` # diff --git a/src/ameba/rule/lint/empty_ensure.cr b/src/ameba/rule/lint/empty_ensure.cr index 7068f5f3..f0cb6973 100644 --- a/src/ameba/rule/lint/empty_ensure.cr +++ b/src/ameba/rule/lint/empty_ensure.cr @@ -32,6 +32,13 @@ module Ameba::Rule::Lint # end # ``` # + # YAML configuration example: + # + # ``` + # Lint/EmptyEnsure + # Enabled: true + # ``` + # struct EmptyEnsure < Base properties do description "Disallows empty ensure statement" diff --git a/src/ameba/rule/lint/empty_expression.cr b/src/ameba/rule/lint/empty_expression.cr index 4e2556b9..bf4d9723 100644 --- a/src/ameba/rule/lint/empty_expression.cr +++ b/src/ameba/rule/lint/empty_expression.cr @@ -24,7 +24,7 @@ module Ameba::Rule::Lint # YAML configuration example: # # ``` - # EmptyExpression: + # Lint/EmptyExpression: # Enabled: true # ``` # diff --git a/src/ameba/rule/lint/hash_duplicated_key.cr b/src/ameba/rule/lint/hash_duplicated_key.cr index 387ad6ee..fd57986b 100644 --- a/src/ameba/rule/lint/hash_duplicated_key.cr +++ b/src/ameba/rule/lint/hash_duplicated_key.cr @@ -16,7 +16,7 @@ module Ameba::Rule::Lint # YAML configuration example: # # ``` - # HashDuplicatedKey: + # Lint/HashDuplicatedKey: # Enabled: true # ``` # diff --git a/src/ameba/rule/lint/literal_in_condition.cr b/src/ameba/rule/lint/literal_in_condition.cr index 03b985c9..1ef8d6a9 100644 --- a/src/ameba/rule/lint/literal_in_condition.cr +++ b/src/ameba/rule/lint/literal_in_condition.cr @@ -16,7 +16,7 @@ module Ameba::Rule::Lint # YAML configuration example: # # ``` - # LiteralInCondition: + # Lint/LiteralInCondition: # Enabled: true # ``` # diff --git a/src/ameba/rule/lint/literal_in_interpolation.cr b/src/ameba/rule/lint/literal_in_interpolation.cr index bd0c22ac..4b6d0307 100644 --- a/src/ameba/rule/lint/literal_in_interpolation.cr +++ b/src/ameba/rule/lint/literal_in_interpolation.cr @@ -12,7 +12,7 @@ module Ameba::Rule::Lint # YAML configuration example: # # ``` - # LiteralInInterpolation + # Lint/LiteralInInterpolation # Enabled: true # ``` # diff --git a/src/ameba/rule/lint/percent_array.cr b/src/ameba/rule/lint/percent_array.cr index fec6ec50..afdf0223 100644 --- a/src/ameba/rule/lint/percent_array.cr +++ b/src/ameba/rule/lint/percent_array.cr @@ -18,7 +18,7 @@ module Ameba::Rule::Lint # YAML configuration example: # # ``` - # PercentArrays: + # Lint/PercentArrays: # Enabled: true # StringArrayUnwantedSymbols: ',"' # SymbolArrayUnwantedSymbols: ',:' diff --git a/src/ameba/rule/lint/rand_zero.cr b/src/ameba/rule/lint/rand_zero.cr index 334a9a4f..be614fad 100644 --- a/src/ameba/rule/lint/rand_zero.cr +++ b/src/ameba/rule/lint/rand_zero.cr @@ -19,7 +19,7 @@ module Ameba::Rule::Lint # YAML configuration example: # # ``` - # RandZero: + # Lint/RandZero: # Enabled: true # ``` # diff --git a/src/ameba/rule/lint/shadowed_argument.cr b/src/ameba/rule/lint/shadowed_argument.cr index 62df0398..0c27c25d 100644 --- a/src/ameba/rule/lint/shadowed_argument.cr +++ b/src/ameba/rule/lint/shadowed_argument.cr @@ -32,7 +32,7 @@ module Ameba::Rule::Lint # YAML configuration example: # # ``` - # ShadowedArgument: + # Lint/ShadowedArgument: # Enabled: true # ``` # diff --git a/src/ameba/rule/lint/shadowed_exception.cr b/src/ameba/rule/lint/shadowed_exception.cr index bf1db302..699a98ea 100644 --- a/src/ameba/rule/lint/shadowed_exception.cr +++ b/src/ameba/rule/lint/shadowed_exception.cr @@ -30,7 +30,7 @@ module Ameba::Rule::Lint # YAML configuration example: # # ``` - # ShadowedException: + # Lint/ShadowedException: # Enabled: true # ``` # diff --git a/src/ameba/rule/lint/shadowing_local_outer_var.cr b/src/ameba/rule/lint/shadowing_local_outer_var.cr index 88609297..eca03512 100644 --- a/src/ameba/rule/lint/shadowing_local_outer_var.cr +++ b/src/ameba/rule/lint/shadowing_local_outer_var.cr @@ -27,7 +27,7 @@ module Ameba::Rule::Lint # YAML configuration example: # # ``` - # ShadowingOuterLocalVar: + # Lint/ShadowingOuterLocalVar: # Enabled: true # ``` # diff --git a/src/ameba/rule/lint/unused_argument.cr b/src/ameba/rule/lint/unused_argument.cr index 4c5da056..f11cab75 100644 --- a/src/ameba/rule/lint/unused_argument.cr +++ b/src/ameba/rule/lint/unused_argument.cr @@ -18,7 +18,7 @@ module Ameba::Rule::Lint # YAML configuration example: # # ``` - # UnusedArgument: + # Lint/UnusedArgument: # Enabled: true # IgnoreDefs: true # IgnoreBlocks: false diff --git a/src/ameba/rule/lint/useless_assign.cr b/src/ameba/rule/lint/useless_assign.cr index a41231ad..80836ac3 100644 --- a/src/ameba/rule/lint/useless_assign.cr +++ b/src/ameba/rule/lint/useless_assign.cr @@ -22,7 +22,7 @@ module Ameba::Rule::Lint # YAML configuration example: # # ``` - # UselessAssign: + # Lint/UselessAssign: # Enabled: true # ``` # diff --git a/src/ameba/rule/lint/useless_condition_in_when.cr b/src/ameba/rule/lint/useless_condition_in_when.cr index d38081c7..7c03f4bd 100644 --- a/src/ameba/rule/lint/useless_condition_in_when.cr +++ b/src/ameba/rule/lint/useless_condition_in_when.cr @@ -27,7 +27,7 @@ module Ameba::Rule::Lint # YAML configuration example: # # ``` - # UselessConditionInWhen: + # Lint/UselessConditionInWhen: # Enabled: true # ``` # diff --git a/src/ameba/rule/style/constant_names.cr b/src/ameba/rule/style/constant_names.cr index 73a4b8aa..fcfd821f 100644 --- a/src/ameba/rule/style/constant_names.cr +++ b/src/ameba/rule/style/constant_names.cr @@ -18,7 +18,7 @@ module Ameba::Rule::Style # YAML configuration example: # # ``` - # ConstantNames: + # Style/ConstantNames: # Enabled: true # ``` # diff --git a/src/ameba/rule/style/large_numbers.cr b/src/ameba/rule/style/large_numbers.cr index 1046d364..a9a2b33d 100644 --- a/src/ameba/rule/style/large_numbers.cr +++ b/src/ameba/rule/style/large_numbers.cr @@ -22,7 +22,7 @@ module Ameba::Rule::Style # YAML configuration example: # # ``` - # LargeNumbers: + # Style/LargeNumbers: # Enabled: true # IntMinDigits: 5 # i.e. integers higher than 9999 # ``` diff --git a/src/ameba/rule/style/method_names.cr b/src/ameba/rule/style/method_names.cr index b56f8084..220c191c 100644 --- a/src/ameba/rule/style/method_names.cr +++ b/src/ameba/rule/style/method_names.cr @@ -34,7 +34,7 @@ module Ameba::Rule::Style # YAML configuration example: # # ``` - # MethodNames: + # Style/MethodNames: # Enabled: true # ``` # diff --git a/src/ameba/rule/style/negated_conditions_in_unless.cr b/src/ameba/rule/style/negated_conditions_in_unless.cr index d56bebea..c612898e 100644 --- a/src/ameba/rule/style/negated_conditions_in_unless.cr +++ b/src/ameba/rule/style/negated_conditions_in_unless.cr @@ -23,7 +23,7 @@ module Ameba::Rule::Style # YAML configuration example: # # ``` - # NegatedConditionsInUnless: + # Style/NegatedConditionsInUnless: # Enabled: true # ``` # diff --git a/src/ameba/rule/style/predicate_name.cr b/src/ameba/rule/style/predicate_name.cr index 3dd6ce87..7c582b5d 100644 --- a/src/ameba/rule/style/predicate_name.cr +++ b/src/ameba/rule/style/predicate_name.cr @@ -25,7 +25,7 @@ module Ameba::Rule::Style # YAML configuration example: # # ``` - # PredicateName: + # Style/PredicateName: # Enabled: true # ``` # diff --git a/src/ameba/rule/style/redundant_begin.cr b/src/ameba/rule/style/redundant_begin.cr index 3f0fb32f..c4a60940 100644 --- a/src/ameba/rule/style/redundant_begin.cr +++ b/src/ameba/rule/style/redundant_begin.cr @@ -52,7 +52,7 @@ module Ameba::Rule::Style # YAML configuration example: # # ``` - # RedundantBegin: + # Style/RedundantBegin: # Enabled: true # ``` # diff --git a/src/ameba/rule/style/type_names.cr b/src/ameba/rule/style/type_names.cr index 9d140f44..fe4be5e1 100644 --- a/src/ameba/rule/style/type_names.cr +++ b/src/ameba/rule/style/type_names.cr @@ -48,7 +48,7 @@ module Ameba::Rule::Style # YAML configuration example: # # ``` - # TypeNames: + # Style/TypeNames: # Enabled: true # ``` # diff --git a/src/ameba/rule/style/unless_else.cr b/src/ameba/rule/style/unless_else.cr index 920dd569..f0f35d90 100644 --- a/src/ameba/rule/style/unless_else.cr +++ b/src/ameba/rule/style/unless_else.cr @@ -39,7 +39,7 @@ module Ameba::Rule::Style # YAML configuration example: # # ``` - # UnlessElse: + # Style/UnlessElse: # Enabled: true # ``` # diff --git a/src/ameba/rule/style/variable_names.cr b/src/ameba/rule/style/variable_names.cr index 325be40d..84ffdebe 100644 --- a/src/ameba/rule/style/variable_names.cr +++ b/src/ameba/rule/style/variable_names.cr @@ -27,7 +27,7 @@ module Ameba::Rule::Style # YAML configuration example: # # ``` - # VariableNames: + # Style/VariableNames: # Enabled: true # ``` # diff --git a/src/ameba/rule/style/while_true.cr b/src/ameba/rule/style/while_true.cr index 4b5b9158..314afc08 100644 --- a/src/ameba/rule/style/while_true.cr +++ b/src/ameba/rule/style/while_true.cr @@ -22,7 +22,7 @@ module Ameba::Rule::Style # YAML configuration example: # # ``` - # WhileTrue: + # Style/WhileTrue: # Enabled: true # ``` #