Pattern: Malformed example description
Issue: -
Checks for common mistakes in example descriptions.
This rule will correct docstrings that begin with 'should' and 'it'.
The autocorrect is experimental - use with care! It can be configured with CustomTransform (e.g. have => has) and IgnoredWords (e.g. only).
# bad
it 'should find nothing' do
end
# good
it 'finds nothing' do
end# bad
it 'it does things' do
end
# good
it 'does things' do
end| Name | Default value | Configurable values |
|---|---|---|
| CustomTransform | {"be"=>"is", "BE"=>"IS", "have"=>"has", "HAVE"=>"HAS"} |
|
| IgnoredWords | [] |
Array |