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
903 B
Plaintext
55 lines
903 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,csharp]
|
|
----
|
|
public class Person
|
|
{
|
|
private static DateTime dateOfBirth;
|
|
private static int expectedFingers;
|
|
|
|
public Person(DateTime birthday)
|
|
{
|
|
dateOfBirth = birthday; // Noncompliant; now everyone has this birthday
|
|
expectedFingers = 10; // Noncompliant
|
|
}
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,csharp]
|
|
----
|
|
public class Person
|
|
{
|
|
private DateTime dateOfBirth;
|
|
private static int expectedFingers = 10;
|
|
|
|
public Person(DateTime birthday)
|
|
{
|
|
this.dateOfBirth = birthday;
|
|
}
|
|
}
|
|
----
|
|
|
|
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[]
|