docs/checks/unreachable_code.md in platformos-check-0.4.12 vs docs/checks/unreachable_code.md in platformos-check-0.4.13
- old
+ new
@@ -1,14 +1,14 @@
-# Unreachable code (`UnreachableCode`)
+# Unreachable Code (`UnreachableCode`)
-Unreachable code reports code that will never be reached, no matter what.
+This check detects and ensures that you do not accidentally write code that will never be executed because it is unreachable.
-## Check Details
+## Examples
-This check is aimed at ensuring you will not accidentally write code that will never be reached.
+The following examples show code snippets that either fail or pass this check:
-:-1: Examples of **incorrect** code for this check:
+### ✗ Incorrect Code Example (Avoid using this):
```liquid
assign x = "hello"
break
log x
@@ -21,11 +21,11 @@
break
log "Stop"
endif
```
-:+1: Examples of **correct** code for this check:
+### ✓ Correct Code Example (Use this instead):
```liquid
assign x = "hello"
log x
break
@@ -38,25 +38,25 @@
log "Stop"
break
endif
```
-## Check Options
+## Configuration Options
-The default configuration for this check is the following:
+The default configuration for this check:
```yaml
UnreachableCode:
enabled: true
```
-## When Not To Use It
+## Disabling This Check
-There should be no cases where disabling this rule is needed.
+Disabling this check is not recommended.
## Version
-This check has been introduced in PlatformOS Check 0.4.7.
+This check has been introduced in platformOS Check 0.4.7.
## Resources
- [Rule Source][codesource]
- [Documentation Source][docsource]