rspec/rules/S2681/php/rule.adoc

== Why is this an issue?

:example: php/example.adoc

include::../description.adoc[]

include::../see.adoc[]

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

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

=== Message

This statement will not be executed [conditionally|in a loop]; only the first statement of this n-statement block will be. The rest will execute [only once|unconditionally].


include::../highlighting.adoc[]

'''
== Comments And Links
(visible only on this page)

include::../comments-and-links.adoc[]

endif::env-github,rspecator-view[]
migrate rule descriptions to new education format 2023-05-03 11:06:20 +02:00			`== Why is this an issue?`

Modify Rule S2681: LaYC comment blocks Co-authored-by: Amélie Renard <44666826+amelie-renard-sonarsource@users.noreply.github.com> 2023-06-16 16:55:05 +02:00			`:example: php/example.adoc`
Add rules 2000-2999 2020-06-30 12:48:07 +02:00
Modify Rule S2681: LaYC comment blocks Co-authored-by: Amélie Renard <44666826+amelie-renard-sonarsource@users.noreply.github.com> 2023-06-16 16:55:05 +02:00			`include::../description.adoc[]`
Add rules 2000-2999 2020-06-30 12:48:07 +02:00
			`include::../see.adoc[]`
Export comments and rspec-to-rspec links from jira 2021-06-02 20:44:38 +02:00
Fix the comment display: rule-id, timestamp, GH visibility, link direction 2021-06-03 09:05:38 +02:00			`ifdef::env-github,rspecator-view[]`
RULEAPI-666: Migrate the "List of parameters", "Highlighting" and "Message" fields from jira RSPEC (#346) 2021-09-20 15:38:42 +02:00
			`'''`
			`== 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`

			`This statement will not be executed [conditionally\|in a loop]; only the first statement of this n-statement block will be. The rest will execute [only once\|unconditionally].`

RULEAPI-666: Migrate the "List of parameters", "Highlighting" and "Message" fields from jira RSPEC (#346) 2021-09-20 15:38:42 +02:00
			`include::../highlighting.adoc[]`

RULEAPI-576: add a horizontal rule between rule description and comments 2021-06-08 15:52:13 +02:00			`'''`
Export comments and rspec-to-rspec links from jira 2021-06-02 20:44:38 +02:00			`== Comments And Links`
			`(visible only on this page)`

			`include::../comments-and-links.adoc[]`
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
Fix the comment display: rule-id, timestamp, GH visibility, link direction 2021-06-03 09:05:38 +02:00			`endif::env-github,rspecator-view[]`