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.
52 lines
1011 B
Plaintext
52 lines
1011 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,php]
|
|
----
|
|
class FruitException { // Noncompliant; this has nothing to do with Exception
|
|
private $expected;
|
|
private $unusualCharacteristics;
|
|
private $appropriateForCommercialExploitation;
|
|
// ...
|
|
}
|
|
|
|
class CarException { // Noncompliant; the extends clause was forgotten?
|
|
public function __construct(string message, Throwable cause) {
|
|
// ...
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,php]
|
|
----
|
|
class FruitSport {
|
|
private $expected;
|
|
private $unusualCharacteristics;
|
|
private $appropriateForCommercialExploitation;
|
|
// ...
|
|
}
|
|
|
|
class CarException extends Exception {
|
|
public function __construct(string message, Throwable cause) {
|
|
// ...
|
|
----
|
|
|
|
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[]
|