rspec/rules/S2316/python/rule.adoc

This rule raises an issue when backticks are used instead of `repr`.

== Why is this an issue?

In Python 2, backticks are a deprecated alias for ``++repr()++``. The syntax was removed in Python 3. To make the transition to Python 3 easier, they should not be used anymore.


=== Noncompliant code example

[source,python]
----
return `num`  # Noncompliant
----


=== Compliant solution

[source,python]
----
return repr(num)
----

ifdef::env-github,rspecator-view[]

'''
== Implementation Specification
(visible only on this page)

=== Message

Use "repr" instead.


endif::env-github,rspecator-view[]
Modify rule S2316: LaYC format (#2657) 2023-08-04 17:15:31 +02:00			This rule raises an issue when backticks are used instead of `repr`.

migrate rule descriptions to new education format 2023-05-03 11:06:20 +02:00			`== Why is this an issue?`

Modify rule S2316: LaYC format (#2657) 2023-08-04 17:15:31 +02:00			In Python 2, backticks are a deprecated alias for ``++repr()++``. The syntax was removed in Python 3. To make the transition to Python 3 easier, they should not be used anymore.
Restructure one-lang rspecs 2021-04-28 16:49:39 +02:00
Fix the missing default metadata fields 2021-04-28 18:08:03 +02:00
migrate rule descriptions to new education format 2023-05-03 11:06:20 +02:00			`=== Noncompliant code example`
Restructure one-lang rspecs 2021-04-28 16:49:39 +02:00
RULEAPI-661: Add syntax coloring 2022-02-04 17:28:24 +01:00			`[source,python]`
Restructure one-lang rspecs 2021-04-28 16:49:39 +02:00			`----`
			return `num` # Noncompliant
			`----`

Fix the missing default metadata fields 2021-04-28 18:08:03 +02:00
migrate rule descriptions to new education format 2023-05-03 11:06:20 +02:00			`=== Compliant solution`
Restructure one-lang rspecs 2021-04-28 16:49:39 +02:00
RULEAPI-661: Add syntax coloring 2022-02-04 17:28:24 +01:00			`[source,python]`
Restructure one-lang rspecs 2021-04-28 16:49:39 +02:00			`----`
			`return repr(num)`
			`----`
Fix the missing default metadata fields 2021-04-28 18:08:03 +02:00
RULEAPI-666: Migrate the "List of parameters", "Highlighting" and "Message" fields from jira RSPEC (#346) 2021-09-20 15:38:42 +02:00			`ifdef::env-github,rspecator-view[]`

			`'''`
			`== Implementation Specification`
			`(visible only on this page)`

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			`=== Message`

			`Use "repr" instead.`

RULEAPI-666: Migrate the "List of parameters", "Highlighting" and "Message" fields from jira RSPEC (#346) 2021-09-20 15:38:42 +02:00
			`endif::env-github,rspecator-view[]`