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.
71 lines
961 B
Plaintext
71 lines
961 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,php]
|
|
----
|
|
class Child extends Parent {
|
|
|
|
public function func($n,$m) {
|
|
parent::func($n$m); // Noncompliant
|
|
}
|
|
}
|
|
|
|
class Parent {
|
|
public function func($n, $m) {
|
|
// do something
|
|
}
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,php]
|
|
----
|
|
class Child extends Parent {
|
|
|
|
public function func($n,$m) {
|
|
parent::func($n$m);
|
|
// do additional things...
|
|
}
|
|
}
|
|
|
|
class Parent {
|
|
public function func($n, $m) {
|
|
// do something
|
|
}
|
|
}
|
|
----
|
|
or
|
|
|
|
[source,php]
|
|
----
|
|
class Child extends Parent {
|
|
// function eliminated
|
|
}
|
|
|
|
class Parent {
|
|
public function func($n, $m) {
|
|
// do something
|
|
}
|
|
}
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|