Skip to content

Commit 7a64610

Browse files
authored
feat: don't report an error for 'APIs' (redhat-documentation#489
* fixes redhat-documentation#488 * fixes also other rules that should not raise alert on files in the `Definitions/testvalid.adoc` file Signed-off-by: Fabrice Flore-Thébault <[email protected]>
1 parent e3c0f34 commit 7a64610

File tree

5 files changed

+28
-6
lines changed

5 files changed

+28
-6
lines changed

.vale/fixtures/RedHat/Definitions/testvalid.adoc

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
// suppress inspection "IncorrectFormatting" for whole file
12
ACPI
23
AIX
34
API
5+
APIs
46
ARM
57
ASCII
68
ASP

.vale/fixtures/RedHat/PascalCamelCase/testvalid.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// suppress inspection "IncorrectFormatting" for whole file
12
== camelCase term should not be flagged in headings
23
3scale
34
AGPLv

.vale/fixtures/RedHat/Spelling/testvalid.adoc

+14-4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// suppress inspection "IncorrectFormatting" for whole file
12
a .NET application
23
accessor
34
adoc
@@ -8,12 +9,13 @@ Annobin
89
Ansible
910
Antora
1011
API
12+
APIs
1113
AssertJ
1214
autostart
1315
Autostart
1416
aws
1517
AWS
16-
Azure
18+
Microsoft Azure
1719
backfilling
1820
Backfilling
1921
backtrace
@@ -38,7 +40,7 @@ Bugzilla
3840
build config
3941
CentOS
4042
Ceph
41-
cephfs
43+
CephFS
4244
cgroup
4345
che
4446
Che
@@ -64,12 +66,15 @@ configure
6466
Containerfile
6567
Containerfiles
6668
Cookiecutter
69+
CPU
70+
CPUs
6771
CR
6872
CRD
6973
CRDs
7074
CRs
7175
CSVs
7276
Ctrl
77+
CVEs
7378
Cygmon
7479
DaemonSet
7580
Datadog
@@ -121,10 +126,13 @@ Fortran
121126
Funqy
122127
Gbps
123128
GCC
129+
GID
130+
GIDs
124131
Git
125132
GitHub
126133
GitLab
127134
Gluster
135+
GNUPro
128136
GraalVM
129137
Gradle
130138
Grafana
@@ -166,7 +174,6 @@ Journald
166174
Journaling
167175
Joyent
168176
JUnit
169-
jvm
170177
JVM
171178
Kafka
172179
kbd
@@ -240,6 +247,7 @@ Operator
240247
osd
241248
overridable
242249
PHP
250+
PIDs
243251
Podman
244252
PostgreSQL
245253
PowerShell
@@ -281,8 +289,10 @@ Rolfe
281289
Rollout
282290
Rollouts
283291
Rollup
292+
ROMs
284293
Roundtable
285294
Roundtables
295+
RPMs
286296
ruleset
287297
Runlevel
288298
Runlevels
@@ -346,6 +356,7 @@ Traceback
346356
Traefik
347357
Truststore
348358
Uber
359+
UIDs
349360
Uncomment
350361
Undercloud
351362
Uninstallation
@@ -358,7 +369,6 @@ Upsell
358369
Upselling
359370
URI
360371
URIs
361-
url
362372
URL
363373
URLs
364374
Valgrind

.vale/styles/RedHat/Definitions.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ first: '\b([A-Z]{3,5}s?)\b'
1010
second: '\(([A-Z]{3,5}s?)\)'
1111
# ... with the exception of these:
1212
exceptions:
13+
- 'APIs?'
1314
- 'CPUs?'
1415
- 'CVEs?'
1516
- 'DVDs?'
@@ -23,11 +24,10 @@ exceptions:
2324
- 'URLs?'
2425
- ACPI
2526
- AIX
26-
- API
2727
- ARM
2828
- ASCII
2929
- ASP
30-
- AWS
30+
- AWS
3131
- BIND
3232
- BIOS
3333
- BMC

.vale/styles/RedHat/Spelling.yml

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
#file: noinspection IncorrectFormatting
12
---
23
extends: spelling
34
level: warning
@@ -187,12 +188,14 @@ filters:
187188
- Containerfile
188189
- Containerfiles
189190
- Cookiecutter
191+
- CPUs
190192
- CR
191193
- CRD
192194
- CRDs
193195
- CRs
194196
- CSVs
195197
- Ctrl
198+
- CVEs
196199
- Cygmon
197200
- DaemonSet
198201
- Datadog
@@ -218,9 +221,11 @@ filters:
218221
- Fortran
219222
- Funqy
220223
- GCC
224+
- GIDs
221225
- GitHub
222226
- GitLab
223227
- Gluster
228+
- GNUPro
224229
- Gradle
225230
- Grayscale
226231
- GraalVM
@@ -292,6 +297,7 @@ filters:
292297
- OpenTracing
293298
- osd
294299
- PHP
300+
- PIDs
295301
- Podman
296302
- PostgreSQL
297303
- PowerShell
@@ -309,6 +315,8 @@ filters:
309315
- RESTEasy
310316
- Rolfe
311317
- Rollup
318+
- ROMs
319+
- RPMs
312320
- Sakila
313321
- sbt
314322
- SCM
@@ -329,6 +337,7 @@ filters:
329337
- Toolset
330338
- Traefik
331339
- Uber
340+
- UIDs
332341
- URI
333342
- URIs
334343
- url

0 commit comments

Comments
 (0)