Sha256: 18fad75a292263dcc2a15487380fa92d3b2946d7c645fbc23f215123a9a57890

Contents?: true

Size: 932 Bytes

Versions: 15

Compression:

Stored size: 932 Bytes

Contents

# Long Yield List

## Introduction

A _Long Yield List_ occurs when a method yields a lot of arguments to the block it gets passed.

## Example

```Ruby
class Dummy
  def yields_a_lot(foo,bar,baz,fling,flung)
    yield foo,bar,baz,fling,flung
  end
end
```

`reek` would report the following warning:

```
test.rb -- 1 warning:
  [4]:Dummy#yields_a_lot yields 5 parameters (LongYieldList)
```

A common solution to this problem would be the introduction of parameter objects.

## Current Support in Reek

Currently Long Parameter List reports any method or block with more than 3 parameters.

## Configuration

Reek's Long Parameter List detector supports the [Basic Smell Options](Basic-Smell-Options.md), plus:

| Option         | Value       | Effect  |
| ---------------|-------------|---------|
| max_params |  integer | The maximum number of parameters allowed in a method or block before a warning is issued. Defaults to 3. |

Version data entries

15 entries across 15 versions & 1 rubygems

Version Path
reek-3.5.0 docs/Long-Yield-List.md
reek-3.4.1 docs/Long-Yield-List.md
reek-3.4.0 docs/Long-Yield-List.md
reek-3.3.1 docs/Long-Yield-List.md
reek-3.3.0 docs/Long-Yield-List.md
reek-3.2.1 docs/Long-Yield-List.md
reek-3.2 docs/Long-Yield-List.md
reek-3.1 docs/Long-Yield-List.md
reek-3.0.4 docs/Long-Yield-List.md
reek-3.0.3 docs/Long-Yield-List.md
reek-3.0.2 docs/Long-Yield-List.md
reek-3.0.1 docs/Long-Yield-List.md
reek-3.0.0 docs/Long-Yield-List.md
reek-2.2.1 docs/Long-Yield-List.md
reek-2.2.0 docs/Long-Yield-List.md