51369b610e
When an include is not surrounded by empty lines, its content is inlined on the same line as the adjacent content. That can lead to broken tags and other display issues. This PR fixes all such includes and introduces a validation step that forbids introducing the same problem again.
62 lines
1.5 KiB
Plaintext
62 lines
1.5 KiB
Plaintext
== Why is this an issue?
|
|
|
|
When the call to a function doesn't have any side effects, what is the point of making the call if the results are ignored? In such case, either the function call is useless and should be dropped or the source code doesn't behave as expected.
|
|
|
|
|
|
This rule raises an issue when a builtin function or methods which has no side effects is called and its result is not used.
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,python]
|
|
----
|
|
myvar = "this is a multiline"
|
|
"message from {}".format(sender) # Noncompliant. The formatted string is not used because the concatenation is not done properly.
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,python]
|
|
----
|
|
myvar = ("this is a multiline"
|
|
"message from {}".format(sender))
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
No issue will be raised when the function or method call is in a ``++try...except++`` body. This usually indicates that an exception is expected, and this exception is the side-effect.
|
|
|
|
[source,python]
|
|
----
|
|
def tryExcept():
|
|
d = {}
|
|
try:
|
|
d[1]
|
|
except IndexError as e:
|
|
pass
|
|
|
|
try:
|
|
divmod(1, 0)
|
|
except ZeroDivisionError as e:
|
|
pass
|
|
----
|
|
|
|
== Resources
|
|
|
|
* https://docs.python.org/3/library/functions.html[Python documentation - Built-in Functions]
|
|
|
|
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[]
|