Skip to content

Commit 58533c2

Browse files
updated quality check
1 parent e6dffb1 commit 58533c2

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

content/english/blog/083_quality-checks-on-liascript-with-github-ensuring-document-excellence.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -396,19 +396,20 @@ When your workflow runs, it will produce output for each tool. Here's how to int
396396

397397
CSpell will list misspelled words along with their location and suggestions:
398398

399-
```
399+
``` bash
400400
/path/to/file.md:10:15 - Unknown word (beispiel)
401401
```
402402

403403
For each flagged word, you can:
404+
404405
1. Fix the spelling if it's truly an error
405406
2. Add it to your `.cspell.json` ignore list if it's correct but unknown to the dictionary
406407

407408
### Understanding Write-Good Output
408409

409410
Write-Good highlights style issues with explanations:
410411

411-
```
412+
``` bash
412413
/path/to/file.md:15:10 - "very" can weaken meaning
413414
```
414415

@@ -421,7 +422,7 @@ For each suggestion:
421422

422423
Alex provides detailed explanations of potentially problematic language:
423424

424-
```
425+
``` bash
425426
/path/to/file.md:20:5 - "crazy" may be insensitive, use "surprising", "unexpected", or "unusual" instead
426427
```
427428

@@ -434,11 +435,12 @@ For each flagged term:
434435

435436
Proselint gives detailed style and grammar suggestions:
436437

437-
```
438+
``` bash
438439
/path/to/file.md:25:8 - typography.symbols.curly_quotes Use curly quotes instead of straight quotes.
439440
```
440441

441442
For each suggestion:
443+
442444
1. Review the specific style rule being applied
443445
2. Decide if it's appropriate for your document
444446

0 commit comments

Comments
 (0)