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.
87 lines
1.2 KiB
Plaintext
87 lines
1.2 KiB
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,flex]
|
|
----
|
|
public function func(foo:Number, bar:Number):void
|
|
{
|
|
switch (foo)
|
|
{
|
|
case 1:
|
|
// do something
|
|
break;
|
|
case 2:
|
|
switch (bar) // Noncompliant
|
|
{
|
|
case 89: // It's easy to lose sight of what's being tested; is it foo or bar?
|
|
// ...
|
|
break;
|
|
case 90:
|
|
// ...
|
|
break;
|
|
}
|
|
break;
|
|
case 3:
|
|
// do something
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,flex]
|
|
----
|
|
public function func(foo:Number, bar:Number):void
|
|
{
|
|
switch (foo)
|
|
{
|
|
case 1:
|
|
// ...
|
|
break;
|
|
case 2:
|
|
handleBar(bar);
|
|
break;
|
|
case 3:
|
|
// ...
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
}
|
|
|
|
public function handleBar(bar:Number):void
|
|
{
|
|
switch (bar)
|
|
{
|
|
case 89:
|
|
// ...
|
|
break;
|
|
case 90:
|
|
// ...
|
|
break;
|
|
}
|
|
}
|
|
----
|
|
|
|
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[]
|