72 lines
1.6 KiB
Plaintext
72 lines
1.6 KiB
Plaintext
|
= Rule Description
|
||
|
|
|
||
|
|
This document describes how `+rule.adoc+` and its dependencies should be structured.
|
||
|
|
|
||
|
|
== Sections
|
||
|
|
|
||
|
|
There should be no first level titles (`+= Title+`) in your adoc.
|
||
|
|
|
||
|
|
The following are the only allowed second level titles for H2:
|
||
|
|
|
||
|
|
include::section_names.adoc[]
|
||
|
|
|
||
|
|
Third level titles are not checked.
|
||
|
|
|
||
|
|
== Parameters
|
||
|
|
|
||
|
|
Parameters should be listed in a subsection as follow:
|
||
|
|
|
||
|
|
....
|
||
|
|
=== Parameters
|
||
|
|
|
||
|
|
.name
|
||
|
|
****
|
||
|
|
_TYPE_
|
||
|
|
|
||
|
|
----
|
||
|
|
default value
|
||
|
|
----
|
||
|
|
|
||
|
|
Description of what the parameter does.
|
||
|
|
****
|
||
|
|
|
||
|
|
.name2
|
||
|
|
****
|
||
|
|
----
|
||
|
|
another default value
|
||
|
|
----
|
||
|
|
Description of what this second parameter does.
|
||
|
|
****
|
||
|
|
|
||
|
|
.name3
|
||
|
|
****
|
||
|
|
_TYPE_
|
||
|
|
|
||
|
|
Description of what this third parameter does.
|
||
|
|
****
|
||
|
|
|
||
|
|
.name4
|
||
|
|
****
|
||
|
|
Description of what this fourth parameter does.
|
||
|
|
****
|
||
|
|
|
||
|
|
....
|
||
|
|
|
||
|
|
The parameter name and the description are mandatory. The type and default value are not.
|
||
|
|
|
||
|
|
The parameter name with a `.` before will be the title of the block below marked by `****`.
|
||
|
|
|
||
|
|
We always use `----` around the default parameter to avoid having a special character confuse AsciiDoctor and to create a visual consistency for all parameters.
|
||
|
|
|
||
|
|
== Comment a rule
|
||
|
|
|
||
|
|
Comments and links that were created on Jira have been gathered in a `comments-and-links.adoc` file for each concerned rule. +
|
||
|
|
You can add a comment anywhere in a rule by adding the following lines in the `*.adoc` file:
|
||
|
|
[source]
|
||
|
|
----
|
||
|
|
\ifdef::env-github,rspecator-view[]
|
||
|
|
John Doe (9 Jun 2021, 15:49): my comment on the rule
|
||
|
|
\endif::env-github,rspecator-view[]
|
||
|
|
----
|
||
|
|
This way, your comment will only be visible in GitHub preview and on the Search Page (and will not be visible for the user).
|