18 Commits

Author SHA1 Message Date
Martin Strecker
3e93c74572
NET-407 Update S2551 rule description. (#4445)
* Update S2551 rule description.

* Add new line

* Newlines
2024-10-29 11:39:01 +00:00
kevin.hinz
7bb601b5d7
Modify rule S2551: clarify example used in the description (#3713)
* Modify rule S2551: clarify example in description

* Modify rule S2551: improve word choice
2024-03-15 14:40:37 +01:00
kevin.hinz
a46b16aa88
Modify rule: Update rule descriptions (#3655)
Changes suggested by the Docs Squad:

* Modify rule s2178: Update rule description
- formalize word selection to clarify the description

* Modify rule S2551: capitalize `String`
- follow the capitalization of a proper noun, in accordance with the referenced link

* Modify rule S3923: improve word choice

* Modify rule S2551: capitalize String
- `String` is used as a VB `object` in this example. 
- A new PR will be issued to make a more substantial improvement
2024-02-23 13:55:16 +01:00
kevin.hinz
5c414c2bf1
Modify rule: Update rule descriptions (#3632)
* Modify rule S1110: Update rule description

Improve grammar and sentence structure.

* Modify rule S3603: Update rule description

Improve grammar in the sentence structure.

* Modify rule S3449: Update rule description

Clarify the sentence structure with minor word changes.

* Modify rule S3449: correct word in description

Correct spelling mistakes in two instances of one word.
2024-02-09 10:42:26 +01:00
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
Gregory Paidis
093ecc0d4d
Modify rule S2551: LaYC format (#2108) 2023-06-08 15:36:00 +02:00
Victor
fe961619f9 migrate rule descriptions to new education format 2023-05-05 16:29:04 +02:00
Fred Tingaud
b4161466e6
RULEAPI-661: Add syntax coloring 2022-02-04 16:28:24 +00:00
Arseniy Zaostrovnykh
f7904cebe7
RULEAPI-666: Migrate the "List of parameters", "Highlighting" and "Message" fields from jira RSPEC (#346) 2021-09-20 13:38:42 +00:00
Arseniy Zaostrovnykh
b76bc57083
RULEAPI-576: add a horizontal rule between rule description and comments 2021-06-08 15:52:13 +02:00
Arseniy Zaostrovnykh
6c1ad2c13c Fix the comment display: rule-id, timestamp, GH visibility, link direction 2021-06-03 09:05:38 +02:00
Arseniy Zaostrovnykh
cdd7690a79 Export comments and rspec-to-rspec links from jira 2021-06-02 20:44:38 +02:00
Arseniy Zaostrovnykh
7ca29f686f Force linebreaks 2021-02-02 15:02:10 +01:00
Arseniy Zaostrovnykh
d4598ce0f9 make in-line code blocks verbatim 2021-01-27 13:42:22 +01:00
Arseniy Zaostrovnykh
d96d948333 change the inline-code delimitters 2020-12-23 14:59:06 +01:00
Arseniy Zaostrovnykh
ed53c1610b Add all rules, update all rules fixing the inline code syntax 2020-12-21 15:38:52 +01:00
Alban Auzeill
2c306d110e Fix code block ambiguity with old header style
Ensure blank line before list and clean the one leading space
2020-06-30 17:16:12 +02:00
Alban Auzeill
9ebd45f206 Add rules 2000-2999 2020-06-30 17:16:12 +02:00