rspec/rules/S115/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

55 lines
1.1 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

== Why is this an issue?
include::../description.adoc[]
=== Noncompliant code example
With the default regular expression ``++^[a-z][a-zA-Z0-9]*$++``:
[source,swift]
----
let Pi = 3.14
----
=== Compliant solution
[source,swift]
----
let pi = 3.14
----
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 constant names against.
****
'''
== Comments And Links
(visible only on this page)
=== on 15 May 2015, 09:40:57 Elena Vilchik wrote:
\[~ann.campbell.2] I want to change default parameter value on camelCase (based on examples \https://developer.apple.com/library/mac/documentation/Swift/Conceptual/Swift_Programming_Language/TheBasics.html#//apple_ref/doc/uid/TP40014097-CH5-ID310 and recommendations \http://ericasadun.com/2015/05/05/swift-dont-do-that/ "Dont use ALL_CAPS"). Any objections?
=== on 15 May 2015, 11:56:52 Ann Campbell wrote:
None whatsoever [~elena.vilchik]. You're the language expert! :-)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]