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.
63 lines
1.0 KiB
Plaintext
63 lines
1.0 KiB
Plaintext
== Why is this an issue?
|
|
|
|
:func_name: function
|
|
|
|
include::../description.adoc[]
|
|
|
|
[source,kotlin,diff-id=1,diff-type=noncompliant]
|
|
----
|
|
class MyClass {
|
|
fun calculateCode(): String {
|
|
doTheThing()
|
|
doOtherThing()
|
|
return "done"
|
|
}
|
|
|
|
fun getStatus(): String { // Noncompliant: duplicates calculateCode
|
|
doTheThing()
|
|
doOtherThing()
|
|
return "done"
|
|
}
|
|
}
|
|
----
|
|
|
|
include::../inter.adoc[]
|
|
|
|
[source,kotlin,diff-id=1,diff-type=compliant]
|
|
----
|
|
class MyClass {
|
|
fun calculateCode(): String {
|
|
doTheThing()
|
|
doOtherThing()
|
|
return "done"
|
|
}
|
|
|
|
fun getStatus(): String = calculateCode() // Intent is clear
|
|
}
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
Methods with fewer than 2 statements are ignored.
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Update this function so that its implementation is not identical to "XXX" on line n
|
|
|
|
|
|
include::../highlighting.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|