ishangsf/rspec
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update LaYC "More info" section with "Related rules" subtitle

Browse Source
This commit is contained in:
Amélie Renard 2023-07-03 15:10:21 +02:00 committed by GitHub
parent 17a6d54a1d
commit ee50358ea1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/description.adoc
View File

@ -60,6 +60,7 @@ This format is defined as follows:
** Conference presentations
** Standards
** Benchmarks
** Related rules
Where the `How to fix it in {Framework Display Name}` section can be repeated multiple times when the rule description is defined per-framework.
@ -118,6 +119,10 @@ Goal: Allow the user to dig deeper by providing a curated list of resources.
* *Conference presentations* (level 3 title) [Optional]
* *Standards* (level 3 title) [Optional]
* *Benchmarks* (level 3 title) [Optional]
* *Related rules* (level 3 title) [Optional]
+
This section lists Sonar rules related to the current one. The rule ID(s) should be followed by the rule title(s) or a sentence explaining the relation between the rules, e.g.: "_S2275 and S3457 specialize in detecting type mismatches with format strings._".
Note that most sections and subsections are optional, only the `Why is this an issue?` main section is mandatory.