Sha256: 14e088c72f469689a5ed72a547d6b25ef0c37ccadd6d8869d50422b515924fec
Contents?: true
Size: 1 KB
Versions: 3
Compression:
Stored size: 1 KB
Contents
# Uncommunicative Module Name ## Introduction An `Uncommunicative Module Name` is a module name that doesn't communicate its intent well enough. Poor names make it hard for the reader to build a mental picture of what's going on in the code. They can also be mis-interpreted; and they hurt the flow of reading, because the reader must slow down to interpret the names. ## Current Support in reek `Uncommunicative Module Name` checks for: * 1-character names * any name ending with a number ## Configuration `reek`'s `Uncommunicative Module Name` detector supports the [Basic Smell Options](Basic-Smell-Options.md), plus: | Option | Value | Effect | | ---------------|-------------|---------| | `reject` | array of regular expressions | The set of regular expressions that `reek` uses to check for bad names. Defaults to `[/^.$/, /[0-9]$/]`. | | `accept` | array of names as strings | List of names that will be accepted (not reported) even if they match one of the `reject` expressions. Empty by default.|
Version data entries
3 entries across 3 versions & 1 rubygems
Version | Path |
---|---|
reek-3.5.0 | docs/Uncommunicative-Module-Name.md |
reek-3.4.1 | docs/Uncommunicative-Module-Name.md |
reek-3.4.0 | docs/Uncommunicative-Module-Name.md |