rspec/rules/S5953/python/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

47 lines
706 B
Plaintext

== Why is this an issue?
Variables, Classes and functions should not be undefined, otherwise the code will fail with a NameError.
=== Noncompliant code example
[source,python]
----
my_var # Noncompliant (variable is never defined)
def noncompliant():
foo() # Noncompliant
MyClass() # Noncompliant
----
=== Compliant solution
[source,python]
----
from mod import my_var
my_var
def compliant():
foo = sum
foo()
class MyClass:
pass
MyClass()
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
XX is not defined. Change its name or define it before using it.
endif::env-github,rspecator-view[]