Contents

# Irresponsible Module

## Introduction

Classes and modules are the units of reuse and release. It is therefore considered good practice to annotate every class and module with a brief comment outlining its responsibilities.

## Example

Given

```Ruby
class Dummy
  # Do things...
end
```

`reek` would emit the following warning:

```
test.rb -- 1 warning:
  [1]:Dummy has no descriptive comment (IrresponsibleModule)
```

Fixing this is simple - just an explaining comment:

```Ruby
# The Dummy class is responsible for ...
class Dummy
  # Do things...
end
```

## Current Support in reek

`Irresponsible Module` currently checks classes, but not modules.

## Configuration

`Irresponsible Module` supports only the [Basic Smell Options](Basic-Smell-Options.md).

Version data entries

15 entries across 15 versions & 1 rubygems

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