Skip to content

Commit 59668c7

Browse files
committed
Remove text confusing to the MD parser, clarify other parts of the text
1 parent d6a77d1 commit 59668c7

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

proof/spelling/SpellerOverview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ Being in the **Production** group means the speller has been tested and is consi
2424

2525
This objective classification ensures transparency and gives language teams clear upgrade criteria.
2626

27-
**Suggestion Quality (S):** The tables below include a "Suggestion Quality" column showing how well each spellchecker provides correct spelling suggestions. The badge displays three values: **First% \| Top5% \| Tests**
27+
**Suggestion Quality (S):** The tables below include a "Suggestion Quality" column showing how well each spellchecker provides correct spelling suggestions. The test data is taken from `tools/spellcheckers/test/typos.tsv` in each repository. The badge displays three values:
2828

2929
- **First%**: Percentage of typos where the correct word is the first suggestion
3030
- **Top5%**: Percentage of typos where the correct word is in the top 5 suggestions
31-
- **Tests**: Number of typo test cases evaluated (formatted as "k" for thousands)
31+
- **Tests**: Number of typo test cases evaluated (formatted as "k" for thousands) (true positives in the file mentioned above, other entries are ignored in the calculation)
3232

3333
Badge colors indicate overall quality based on [these thresholds](https://github.com/giellalt/giella-core/blob/main/scripts/make-spellerbadge-json.sh#L84-L97):
3434
- 🟢 **Green** (good): First ≥ 80% AND Top5 ≥ 90% AND Tests ≥ 1000

0 commit comments

Comments
 (0)