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

17 entries across 17 versions & 1 rubygems

Version	Path
reek-4.0.1	docs/Irresponsible-Module.md
reek-4.0.0	docs/Irresponsible-Module.md
reek-4.0.0.pre1	docs/Irresponsible-Module.md
reek-3.11	docs/Irresponsible-Module.md
reek-3.10.2	docs/Irresponsible-Module.md
reek-3.10.1	docs/Irresponsible-Module.md
reek-3.10.0	docs/Irresponsible-Module.md
reek-3.9.1	docs/Irresponsible-Module.md
reek-3.9.0	docs/Irresponsible-Module.md
reek-3.8.3	docs/Irresponsible-Module.md
reek-3.8.2	docs/Irresponsible-Module.md
reek-3.8.1	docs/Irresponsible-Module.md
reek-3.8.0	docs/Irresponsible-Module.md
reek-3.7.1	docs/Irresponsible-Module.md
reek-3.7.0	docs/Irresponsible-Module.md
reek-3.6.1	docs/Irresponsible-Module.md
reek-3.6.0	docs/Irresponsible-Module.md