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

49 lines
772 B
Plaintext

== Why is this an issue?
Since method parameters shouldn't be updated, it makes sense that that's both communicated and enforced with the use of ``++final++``.
This rule raises an issue for methods with non-``++final++`` parameters.
=== Noncompliant code example
[source,text]
----
public void doSomething (String a, int b) { // Noncompliant
// ...
}
----
=== Compliant solution
[source,text]
----
public void doSomething (final String a, final int b) { // Noncompliant
// ...
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Highlighting
Highlight each non-final parameter.
No additional messages needed
=== Message
Make these parameters "final"
endif::env-github,rspecator-view[]