Skip to content

Commit a5c2c8e

Browse files
committed
Correction of various typos in rules documentations
1 parent edc65cb commit a5c2c8e

File tree

40 files changed

+91
-89
lines changed

40 files changed

+91
-89
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1111

1212
### Changed
1313

14+
- Correction of various typos in rules documentations
15+
1416
### Deleted
1517

1618
## [2.2.2] - 2025-03-13

RULES.md

Lines changed: 11 additions & 11 deletions
Large diffs are not rendered by default.

src/main/rules/GCI11/GCI11.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
2-
"title": "Disallow multiple access of same DOM element.",
2+
"title": "Multiple access of same DOM element should be limited",
33
"type": "CODE_SMELL",
44
"code": {
55
"impacts": {
6-
"MAINTAINABILITY": "MEDIUM"
6+
"RELIABILITY": "MEDIUM"
77
},
88
"attribute": "EFFICIENT"
99
},

src/main/rules/GCI11/javascript/GCI11.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Here's an example in JavaScript to illustrate this rule:
1515
[source,js,data-diff-id="2",data-diff-type="noncompliant"]
1616
----
1717
const width = document.getElementById('block').clientWidth;
18-
const height = document.getElementById('block').clientHeight; // Non-compliant
18+
const height = document.getElementById('block').clientHeight; // Noncompliant
1919
----
2020

2121
[source,js,data-diff-id="1",data-diff-type="noncompliant"]
@@ -32,5 +32,5 @@ In the second example, the DOM element reference is cached in the `blockElement`
3232

3333
=== Documentation
3434

35-
- https://github.com/cnumr/best-practices/blob/main/chapters/BP_054_en.md[CNUMR best practices] - Reduce DOM access via JavaScript
35+
- https://github.com/cnumr/best-practices/blob/main/chapters/BP_054_en.md[CnumR best practices] - Reduce DOM access via JavaScript
3636
- https://developer.mozilla.org/en-US/docs/Learn/Performance/JavaScript#tips_for_writing_more_efficient_code[Mozilla Web Technology for Developers] - Tips for writing more efficient code

src/main/rules/GCI12/GCI12.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
2-
"title": "Disallow multiple style changes at once.",
2+
"title": "Multiple style changes should be batched",
33
"type": "CODE_SMELL",
44
"code": {
55
"impacts": {
6-
"MAINTAINABILITY": "MEDIUM"
6+
"RELIABILITY": "MEDIUM"
77
},
88
"attribute": "EFFICIENT"
99
},

src/main/rules/GCI12/javascript/GCI12.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Here's an example in JavaScript and CSS to illustrate this rule:
1616
----
1717
<script>
1818
element.style.height = "800px";
19-
element.style.width = "600px"; // Non-compliant
20-
element.style.color = "red"; // Non-compliant
19+
element.style.width = "600px"; // Noncompliant
20+
element.style.color = "red"; // Noncompliant
2121
</script>
2222
----
2323

@@ -42,4 +42,4 @@ In the first example, multiple CSS properties are set in a single batch, while i
4242

4343
=== Documentation
4444

45-
- https://github.com/cnumr/best-practices/blob/main/chapters/BP_045_en.md[CNUMR best practices] - Modify several CSS properties at once
45+
- https://github.com/cnumr/best-practices/blob/main/chapters/BP_045_en.md[CnumR best practices] - Modify several CSS properties at once

src/main/rules/GCI13/GCI13.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
2-
"title": "Prefer API collections with pagination.",
2+
"title": "API collections should be preferred with pagination",
33
"type": "CODE_SMELL",
44
"code": {
55
"impacts": {
6-
"MAINTAINABILITY": "MEDIUM"
6+
"RELIABILITY": "MEDIUM"
77
},
88
"attribute": "EFFICIENT"
99
},

src/main/rules/GCI13/javascript/GCI13.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This rule is built for the https://nestjs.com[NestJS framework] but can work wit
1616
@Controller()
1717
class Test {
1818
@Get()
19-
public find(): Promise<string[]> {} // Non-compliant
19+
public find(): Promise<string[]> {} // Noncompliant
2020
}
2121
----
2222

@@ -39,7 +39,7 @@ class Test {
3939

4040
=== Documentation
4141

42-
- https://github.com/cnumr/best-practices/blob/main/chapters/BP_076_en.md[CNUMR best practices] - Avoid transferring large amounts of data for processing tasks
42+
- https://github.com/cnumr/best-practices/blob/main/chapters/BP_076_en.md[CnumR best practices] - Avoid transferring large amounts of data for processing tasks
4343
- https://github.com/ppetzold/nestjs-paginate[nestjs-paginate] - Pagination and filtering helper method using Nest.js framework
4444

4545
=== Articles & blog posts

src/main/rules/GCI203/python/GCI203.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ If possible, the utilisation of svg image format (or `<svg/>` html tag) is recom
22

33
Because SVGs are generally smaller than other image format, they’re less taxing on your server despite needing to render on load.
44

5-
When to use SVG :
5+
When to use SVG:
66

77
- Your image is used for decorative website graphics, logos, icons, graphs and diagrams, and other simple images.
88
- You image require animation.

src/main/rules/GCI24/GCI24.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
2-
"title": "Limit the number of returns for a SQL query",
2+
"title": "Returned SQL results should be limited",
33
"type": "CODE_SMELL",
44
"code": {
55
"impacts": {
6-
"MAINTAINABILITY": "MEDIUM"
6+
"RELIABILITY": "MEDIUM"
77
},
88
"attribute": "EFFICIENT"
99
},

0 commit comments

Comments
 (0)