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]:IrresponsibleModule: Dummy has no descriptive comment
```

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_ checks classes and modules, including those
created through `Struct.new` and `Class.new` and directly assigned to a constant.

## Configuration

_Irresponsible Module_ supports only the [Basic Smell Options](Basic-Smell-Options.md).

Version data entries

19 entries across 19 versions & 1 rubygems

Version	Path
reek-4.5.2	docs/Irresponsible-Module.md
reek-4.5.1	docs/Irresponsible-Module.md
reek-4.5.0	docs/Irresponsible-Module.md
reek-4.4.2	docs/Irresponsible-Module.md
reek-4.4.1	docs/Irresponsible-Module.md
reek-4.4.0	docs/Irresponsible-Module.md
reek-4.3.0	docs/Irresponsible-Module.md
reek-4.2.5	docs/Irresponsible-Module.md
reek-4.2.4	docs/Irresponsible-Module.md
reek-4.2.3	docs/Irresponsible-Module.md
reek-4.2.2	docs/Irresponsible-Module.md
reek-4.2.1	docs/Irresponsible-Module.md
reek-4.2.0	docs/Irresponsible-Module.md
reek-4.1.1	docs/Irresponsible-Module.md
reek-4.1.0	docs/Irresponsible-Module.md
reek-4.0.5	docs/Irresponsible-Module.md
reek-4.0.4	docs/Irresponsible-Module.md
reek-4.0.3	docs/Irresponsible-Module.md
reek-4.0.2	docs/Irresponsible-Module.md