fix: remove duplicate link key in 027-non-descriptive-link-text.yml#198
Closed
yanksyoon wants to merge 1 commit into
Closed
fix: remove duplicate link key in 027-non-descriptive-link-text.yml#198yanksyoon wants to merge 1 commit into
yanksyoon wants to merge 1 commit into
Conversation
The file had two 'link:' keys which is invalid YAML — go-yaml silently parses the second value, leaving 'extends' unreadable and causing Vale to abort with a misleading E201 error: 'extends' key must be one of [capitalization conditional ...] Remove the duplicate link, keeping the canonical documentation style guide URL as the single reference.
yanksyoon
force-pushed
the
fix/duplicate-link-key-027
branch
from
a2cfdab to
61a584f
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
styles/Canonical/027-non-descriptive-link-text.ymlcontains twolink:keys:Duplicate keys are invalid YAML. go-yaml (used by Vale) silently discards the first value, leaving
extendsunreadable. This causes Vale to abort with a misleading error:The real cause is the YAML parse failure, not an invalid
extendsvalue.Fix
Remove the duplicate
link:line, keeping the canonical documentation style guide URL as the single reference.Impact
This issue breaks the
docs-checks / valeCI job in any repository that transitively pulls this style file (e.g. viacanonical/platform-engineering-vale-package).