Correct yaml configuration examples in docs

This commit is contained in:
Vitalii Elenhaupt 2018-09-03 22:53:11 +03:00
parent 790b519653
commit 068733a9d3
No known key found for this signature in database
GPG key ID: 7558EF3A4056C706
28 changed files with 34 additions and 27 deletions

View file

@ -4,7 +4,7 @@ module Ameba::Rule::Layout
# YAML configuration example:
#
# ```
# LineLength:
# Layout/LineLength:
# Enabled: true
# MaxLength: 100
# ```

View file

@ -4,7 +4,7 @@ module Ameba::Rule::Layout
# YAML configuration example:
#
# ```
# TrailingBlankLines:
# Layout/TrailingBlankLines:
# Enabled: true
# ```
#

View file

@ -4,7 +4,7 @@ module Ameba::Rule::Layout
# YAML configuration example:
#
# ```
# TrailingWhitespace:
# Layout/TrailingWhitespace:
# Enabled: true
# ```
#

View file

@ -16,7 +16,7 @@ module Ameba::Rule::Lint
# YAML configuration example:
#
# ```
# ComparisonToBoolean:
# Lint/ComparisonToBoolean:
# Enabled: true
# ```
#

View file

@ -7,7 +7,7 @@ module Ameba::Rule::Lint
# YAML configuration example:
#
# ```
# DebuggerStatement:
# Lint/DebuggerStatement:
# Enabled: true
# ```
#

View file

@ -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"

View file

@ -24,7 +24,7 @@ module Ameba::Rule::Lint
# YAML configuration example:
#
# ```
# EmptyExpression:
# Lint/EmptyExpression:
# Enabled: true
# ```
#

View file

@ -16,7 +16,7 @@ module Ameba::Rule::Lint
# YAML configuration example:
#
# ```
# HashDuplicatedKey:
# Lint/HashDuplicatedKey:
# Enabled: true
# ```
#

View file

@ -16,7 +16,7 @@ module Ameba::Rule::Lint
# YAML configuration example:
#
# ```
# LiteralInCondition:
# Lint/LiteralInCondition:
# Enabled: true
# ```
#

View file

@ -12,7 +12,7 @@ module Ameba::Rule::Lint
# YAML configuration example:
#
# ```
# LiteralInInterpolation
# Lint/LiteralInInterpolation
# Enabled: true
# ```
#

View file

@ -18,7 +18,7 @@ module Ameba::Rule::Lint
# YAML configuration example:
#
# ```
# PercentArrays:
# Lint/PercentArrays:
# Enabled: true
# StringArrayUnwantedSymbols: ',"'
# SymbolArrayUnwantedSymbols: ',:'

View file

@ -19,7 +19,7 @@ module Ameba::Rule::Lint
# YAML configuration example:
#
# ```
# RandZero:
# Lint/RandZero:
# Enabled: true
# ```
#

View file

@ -32,7 +32,7 @@ module Ameba::Rule::Lint
# YAML configuration example:
#
# ```
# ShadowedArgument:
# Lint/ShadowedArgument:
# Enabled: true
# ```
#

View file

@ -30,7 +30,7 @@ module Ameba::Rule::Lint
# YAML configuration example:
#
# ```
# ShadowedException:
# Lint/ShadowedException:
# Enabled: true
# ```
#

View file

@ -27,7 +27,7 @@ module Ameba::Rule::Lint
# YAML configuration example:
#
# ```
# ShadowingOuterLocalVar:
# Lint/ShadowingOuterLocalVar:
# Enabled: true
# ```
#

View file

@ -18,7 +18,7 @@ module Ameba::Rule::Lint
# YAML configuration example:
#
# ```
# UnusedArgument:
# Lint/UnusedArgument:
# Enabled: true
# IgnoreDefs: true
# IgnoreBlocks: false

View file

@ -22,7 +22,7 @@ module Ameba::Rule::Lint
# YAML configuration example:
#
# ```
# UselessAssign:
# Lint/UselessAssign:
# Enabled: true
# ```
#

View file

@ -27,7 +27,7 @@ module Ameba::Rule::Lint
# YAML configuration example:
#
# ```
# UselessConditionInWhen:
# Lint/UselessConditionInWhen:
# Enabled: true
# ```
#

View file

@ -18,7 +18,7 @@ module Ameba::Rule::Style
# YAML configuration example:
#
# ```
# ConstantNames:
# Style/ConstantNames:
# Enabled: true
# ```
#

View file

@ -22,7 +22,7 @@ module Ameba::Rule::Style
# YAML configuration example:
#
# ```
# LargeNumbers:
# Style/LargeNumbers:
# Enabled: true
# IntMinDigits: 5 # i.e. integers higher than 9999
# ```

View file

@ -34,7 +34,7 @@ module Ameba::Rule::Style
# YAML configuration example:
#
# ```
# MethodNames:
# Style/MethodNames:
# Enabled: true
# ```
#

View file

@ -23,7 +23,7 @@ module Ameba::Rule::Style
# YAML configuration example:
#
# ```
# NegatedConditionsInUnless:
# Style/NegatedConditionsInUnless:
# Enabled: true
# ```
#

View file

@ -25,7 +25,7 @@ module Ameba::Rule::Style
# YAML configuration example:
#
# ```
# PredicateName:
# Style/PredicateName:
# Enabled: true
# ```
#

View file

@ -52,7 +52,7 @@ module Ameba::Rule::Style
# YAML configuration example:
#
# ```
# RedundantBegin:
# Style/RedundantBegin:
# Enabled: true
# ```
#

View file

@ -48,7 +48,7 @@ module Ameba::Rule::Style
# YAML configuration example:
#
# ```
# TypeNames:
# Style/TypeNames:
# Enabled: true
# ```
#

View file

@ -39,7 +39,7 @@ module Ameba::Rule::Style
# YAML configuration example:
#
# ```
# UnlessElse:
# Style/UnlessElse:
# Enabled: true
# ```
#

View file

@ -27,7 +27,7 @@ module Ameba::Rule::Style
# YAML configuration example:
#
# ```
# VariableNames:
# Style/VariableNames:
# Enabled: true
# ```
#

View file

@ -22,7 +22,7 @@ module Ameba::Rule::Style
# YAML configuration example:
#
# ```
# WhileTrue:
# Style/WhileTrue:
# Enabled: true
# ```
#