rspec/rules/S109/description.adoc

A magic number is a hard-coded numerical value that may lack context or meaning. They should not be used because they can make the code less readable and maintainable.

== Why is this an issue?

Magic numbers make the code more complex to understand as it requires the reader to have knowledge about the global context to understand the number itself.
Their usage may seem obvious when writing the code, but it may not be the case for another developer or later once the context faded away.
-1, 0, and 1 are not considered magic numbers.
Modify S109: Migrate To LayC (#3235) ## Review A dedicated reviewer checked the rule description successfully for: - [x] logical errors and incorrect information - [x] information gaps and missing content - [x] text style and tone - [x] PR summary and labels follow [the guidelines](https://github.com/SonarSource/rspec/#to-modify-an-existing-rule) 2023-10-11 13:58:56 +02:00			`A magic number is a hard-coded numerical value that may lack context or meaning. They should not be used because they can make the code less readable and maintainable.`
Add rules 100-128 (#10) 2020-06-30 10:16:44 +02:00
Modify S109: Migrate To LayC (#3235) ## Review A dedicated reviewer checked the rule description successfully for: - [x] logical errors and incorrect information - [x] information gaps and missing content - [x] text style and tone - [x] PR summary and labels follow [the guidelines](https://github.com/SonarSource/rspec/#to-modify-an-existing-rule) 2023-10-11 13:58:56 +02:00			`== Why is this an issue?`
Force linebreaks 2021-02-02 15:02:10 +01:00
Modify S109: Migrate To LayC (#3235) ## Review A dedicated reviewer checked the rule description successfully for: - [x] logical errors and incorrect information - [x] information gaps and missing content - [x] text style and tone - [x] PR summary and labels follow [the guidelines](https://github.com/SonarSource/rspec/#to-modify-an-existing-rule) 2023-10-11 13:58:56 +02:00			`Magic numbers make the code more complex to understand as it requires the reader to have knowledge about the global context to understand the number itself.`
Modify rule S109: minor grammatical improvement Avoid contractions, simplify sentence and fix typo. 2023-10-16 14:06:43 +02:00			`Their usage may seem obvious when writing the code, but it may not be the case for another developer or later once the context faded away.`
			`-1, 0, and 1 are not considered magic numbers.`