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.
45 lines
762 B
Plaintext
45 lines
762 B
Plaintext
== Why is this an issue?
|
|
|
|
Sharing some naming conventions enables teams to collaborate more efficiently. This rule checks that all ``++struct++`` names match a provided regular expression.
|
|
|
|
|
|
Using the default regular expression: "^[A-Z][a-zA-Z0-9]*$"
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,swift]
|
|
----
|
|
struct my_struct {
|
|
var one : Int
|
|
var two : Int
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,swift]
|
|
----
|
|
struct MyStruct {
|
|
var one : Int
|
|
var two : Int
|
|
}
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
include::../parameters.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|