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
930 B
Plaintext
55 lines
930 B
Plaintext
== Why is this an issue?
|
||
|
||
include::../description.adoc[]
|
||
|
||
=== Noncompliant code example
|
||
|
||
[source,php]
|
||
----
|
||
public function divide($divisor, $dividend) {
|
||
return $divisor/$dividend;
|
||
}
|
||
|
||
public function doTheThing() {
|
||
$divisor = 15;
|
||
$dividend = 5;
|
||
|
||
$result = $this->divide($dividend, $divisor); // Noncompliant; operation succeeds, but result is unexpected
|
||
}
|
||
----
|
||
|
||
=== Compliant solution
|
||
|
||
[source,php]
|
||
----
|
||
public function divide($divisor, $dividend) {
|
||
return $divisor/$dividend;
|
||
}
|
||
|
||
public function doTheThing() {
|
||
$divisor = 15;
|
||
$dividend = 5;
|
||
|
||
$result = $this->divide($divisor, $dividend); // Compliant
|
||
}{code}
|
||
h4.
|
||
----
|
||
|
||
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[]
|