mirror of
https://github.com/docker/docs.git
synced 2026-06-19 07:35:16 +00:00
vale: drop above/below swaps, ignore shortcodes in links, fill vocab gaps
The above/below substitutions fired on idioms ("above and beyond"),
numeric comparisons ("above the 90th percentile"), and version
references ("macOS Ventura and above"), where "previous"/"following"
makes no sense. Drop them — the canonical "see the example above"
case is mild enough that human review can catch it.
Extend TokenIgnores so shortcodes followed by path segments
(``{{% param "x" %}}/dists/``) and shortcodes nested inside markdown
link text are both treated as opaque. Fixes spurious URL/term hits
across the engine/install pages.
Add vocab entries for legitimate technical terms previously flagged by
Vale.Spelling (bootloader, crypto, Kubuntu/Lubuntu/Xubuntu, lockfile,
multimodal, multithreading, NLP, oldoldstable, parallelizable, pnpm,
superset, tokenization, WebGL). Also wrap the `println` heading in
formatting.md in backticks — it's a Go template function, not prose.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
@@ -32,5 +32,5 @@ Vale.Terms = NO
|
||||
|
||||
[*.md]
|
||||
BasedOnStyles = Docker, Vale
|
||||
TokenIgnores = ({{[%<][^}]+[%>]}})
|
||||
TokenIgnores = ({{[%<][^}]+[%>]}}\S*), (\[[^\]]*{{[%<][^}]+[%>]}}[^\]]*\]\([^)]*\))
|
||||
BlockIgnores = (?m)^[ \t]*({{[%<][^}]+[%>]}})[ \t]*$
|
||||
|
||||
@@ -12,7 +12,6 @@ swap:
|
||||
(?:drop down|dropdown): drop-down
|
||||
\blog out\b: sign out
|
||||
\b(?:sign on|log on|log in)\b: sign in
|
||||
above: previous
|
||||
adaptor: adapter
|
||||
administrate: administer
|
||||
afterwards: afterward
|
||||
@@ -25,7 +24,6 @@ swap:
|
||||
anti-virus: antivirus
|
||||
appendixes: appendices
|
||||
assembler: assembly
|
||||
below: following
|
||||
check box: checkbox
|
||||
check boxes: checkboxes
|
||||
click: select
|
||||
|
||||
@@ -410,9 +410,24 @@ OpenSSL
|
||||
[Ss]tringified
|
||||
SwarmKit
|
||||
[Uu]ncomment
|
||||
bootloader
|
||||
Buildkite
|
||||
crypto
|
||||
Graylog
|
||||
Kubuntu
|
||||
Libnetwork
|
||||
lockfile
|
||||
Lubuntu
|
||||
multimodal
|
||||
multithreading
|
||||
NLP
|
||||
Nodemon
|
||||
oldoldstable
|
||||
parallelizable
|
||||
PHPUnit
|
||||
pnpm
|
||||
PyTorch
|
||||
superset
|
||||
tokenization
|
||||
WebGL
|
||||
Xubuntu
|
||||
|
||||
@@ -110,7 +110,7 @@ $ docker image list --format '{{truncate .Repository 15}}'
|
||||
|
||||
This example displays the image repository name, truncating it to the first 15 characters if it's longer.
|
||||
|
||||
## println
|
||||
## `println`
|
||||
|
||||
`println` prints each value on a new line.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user