rspec/rules/S1172/php/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
856 B
Plaintext

== Why is this an issue?
Unused parameters are misleading. Whatever the value passed to such parameters is, the behavior will be the same.
=== Noncompliant code example
[source,php]
----
function doSomething($a, $b) { // "$a" is unused
return compute($b);
}
----
=== Compliant solution
[source,php]
----
function doSomething($b) {
return compute($b);
}
----
=== Exceptions
Functions in classes that override a class or implement interfaces are ignored.
[source,php]
----
class C extends B {
function doSomething($a, $b) { // no issue reported on $b
compute($a);
}
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]