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.
57 lines
752 B
Plaintext
57 lines
752 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
With the default regular expression ``++^[_a-z][a-zA-Z0-9]*$++``:
|
|
|
|
[source,flex]
|
|
----
|
|
public function doSomething(my_param:int):void
|
|
{
|
|
var LOCAL:int;
|
|
...
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,flex]
|
|
----
|
|
public function doSomething(myParam):void
|
|
{
|
|
var local;
|
|
...
|
|
}
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
=== Parameters
|
|
|
|
.format
|
|
****
|
|
|
|
----
|
|
^[_a-z][a-zA-Z0-9]*$
|
|
----
|
|
|
|
Regular expression used to check the names against.
|
|
****
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|