16f6c0aecf
Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in.
40 lines
947 B
Plaintext
40 lines
947 B
Plaintext
== Why is this an issue?
|
|
|
|
A magic number is a number that comes out of nowhere, and is directly used in a statement. Magic numbers are often used, for instance to limit the number of iterations of a loops, to test the value of a property, etc.
|
|
|
|
|
|
Using magic numbers may seem obvious and straightforward when you're writing a piece of code, but they are much less obvious and straightforward at debugging time.
|
|
|
|
That is why magic numbers must be demystified by first being assigned to clearly named variables before being used.
|
|
|
|
|
|
By default, -1, 0 and 1 are not considered magic numbers.
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
=== Parameters
|
|
|
|
.exceptions
|
|
****
|
|
|
|
----
|
|
-1,0,1
|
|
----
|
|
|
|
Comma separated list of allowed exceptions
|
|
****
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
endif::env-github,rspecator-view[]
|