rspec/rules/S2070/swift/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

50 lines
1.2 KiB
Plaintext

== Why is this an issue?
include::../description.adoc[]
=== Noncompliant code example
[source,swift]
----
import CryptoSwift
let bytes:Array<UInt8> = [0x01, 0x02, 0x03]
let digest = input.md5() // Noncompliant
----
=== Compliant solution
[source,swift]
----
import CryptoSwift
let bytes:Array<UInt8> = [0x01, 0x02, 0x03]
let digest = input.sha256() // Compliant
----
include::../see.adoc[]
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
'''
== Comments And Links
(visible only on this page)
=== on 5 Nov 2020, 09:08:03 Arseniy Zaostrovnykh wrote:
\[~pierre-loup.tristant], Why did you replace "Noncompliant Code Example" with "Sensitive Code Example"? Isn't "Noncompliant Code Example" one of the standard headers (along with "Compliant Solution", and "See")?
=== on 5 Nov 2020, 09:15:28 Pierre-Loup Tristant wrote:
"Sensitive Code Example" is what we use for "Security Hotspots" instead of "Noncompliant Code Example".
Here in fact we should keep "Noncompliant Code Example" and use "Sensitive Code Example" for RSPEC-4790
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]