Skip to content

Commit a084ef7

Browse files
m4sterbunnyjoshuafernandes
authored andcommitted
value fixes - initiates a substitution set, updates readme
1 parent b117345 commit a084ef7

File tree

2 files changed

+22
-6
lines changed

2 files changed

+22
-6
lines changed

spelling/README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,16 @@ Vale too.
4646

4747
## ToDo
4848

49-
### Linea
49+
### Overrides
50+
51+
Attempted to overcome false positives with:
52+
53+
1. /styles/ignore which references the Consensys-common/ignore.txt text file (which should override Vale.Spelling)
54+
2. With styles/Consensys/Overridesyaml which is a dummy extend of "existence" to allow use of an exceptions
55+
list {I am not convinced this is working and its not a ssot method as it will need to repeat the ignore items
56+
for Vale.Spelling}
57+
5058

51-
1. We seem to be using proper noun for Coordinator but not for prover
52-
2. Proper Linea Voyage
5359

54-
### General
55-
2. Will links be false positives, e.g. Can linting for " CLI" work to avoid false positives for links?
56-
3. Can we use reject [here to prevent links being put in this format, is it covered another way?
5760

5861

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
extends: substitution
2+
message: For system-specific term, consider %s instead of "%s"
3+
ignorecase: false
4+
level: warn
5+
action:
6+
name: replace
7+
swap:
8+
# Linea Coordinator system component probably proper noun
9+
coordinator: Coordinator
10+
# Linea Prover system component probably proper noun
11+
prover: Prover
12+
# Linea Voyage
13+
voyage: Voyage

0 commit comments

Comments
 (0)