rspec/rules/S1314/ruby/rule.adoc
Fred Tingaud 51369b610e
Make sure that includes are always surrounded by empty lines (#2270)
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.
2023-06-22 10:38:01 +02:00

47 lines
774 B
Plaintext

== Why is this an issue?
include::../description.adoc[]
=== Noncompliant code example
[source,ruby]
----
my_number = 023 # Noncompliant. my_number will hold 19, not 23 - was this really expected?
----
=== Compliant solution
[source,ruby]
----
my_number = 23
----
=== Exceptions
This rule does not apply to values smaller than 8 and octal values having 3 digits, since 3 digits octal values are often used as file permission masks.
Example:
[source,ruby]
----
permission_mask = 0777
day_of_month = 03
----
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[]