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.
53 lines
774 B
Plaintext
53 lines
774 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,csharp]
|
|
----
|
|
string text = "";
|
|
try
|
|
{
|
|
text = File.ReadAllText(fileName);
|
|
} catch { // Noncompliant
|
|
// ...
|
|
}
|
|
|
|
try
|
|
{
|
|
text = File.ReadAllText(fileName);
|
|
} catch (Exception exc) { // Noncompliant
|
|
// ...
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,csharp]
|
|
----
|
|
string text = "";
|
|
try
|
|
{
|
|
text = File.ReadAllText(fileName);
|
|
} catch (UnauthorizedAccessException exc) {
|
|
// you do not have the required permission
|
|
}
|
|
----
|
|
|
|
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[]
|