rspec/rules/S5664/java/rule.adoc
Fred Tingaud 16f6c0aecf
Inline adoc when include has no additional value (#1940)
Inline adoc files when they are included exactly once.

Also fix language tags because this inlining gives us better information
on what language the code is written in.
2023-05-25 14:18:12 +02:00

53 lines
870 B
Plaintext

== Why is this an issue?
Either use only spaces or only tabs for the indentation of a text block. Mixing white space will lead to a result with irregular indentation.
=== Noncompliant code example
[source,java]
----
String textBlock = """
this is
<tab>text block!
!!!!
""";
----
=== Compliant solution
[source,java]
----
String textBlock = """
this is
text block!
!!!!
""";
----
== Resources
* https://openjdk.java.net/jeps/378[JEP 378: Text Blocks]
* https://openjdk.org/projects/amber/guides/text-blocks-guide[Programmer's Guide To Text Blocks], by Jim Laskey and Stuart Marks
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Use only spaces or only tabs for indentation
=== Highlighting
text block
endif::env-github,rspecator-view[]