51369b610e
When an include is not surrounded by empty lines, its content is inlined on the same line as the adjacent content. That can lead to broken tags and other display issues. This PR fixes all such includes and introduces a validation step that forbids introducing the same problem again.
55 lines
929 B
Plaintext
55 lines
929 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,php]
|
|
----
|
|
if ( $a == $a ) { // always true
|
|
doZ();
|
|
}
|
|
if ( $a != $a ) { // always false
|
|
doY();
|
|
}
|
|
if ( $a == $b && $a == $b ) { // if the first one is true, the second one is too
|
|
doX();
|
|
}
|
|
if ( $a == $b || $a == $b ) { // if the first one is true, the second one is too
|
|
doW();
|
|
}
|
|
|
|
$j = 5 / 5; //always 1
|
|
$k = 5 - 5; //always 0
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
Left-shifting 1 onto 1 is common in the construction of bit masks, and is ignored.
|
|
|
|
[source,php]
|
|
----
|
|
$i = 1 << 1; // Compliant
|
|
$j = $a << $a; // Noncompliant
|
|
----
|
|
|
|
include::../see.adoc[]
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
include::../highlighting.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|